jsdoc-to-markdown
Advanced tools
jsdoc-to-markdown - npm Package Compare versions
Comparing version 0.2.13 to 0.2.14
@@ -13,3 +13,3 @@ var a = require("array-tools"); | ||
| return this.scope === "instance" | ||
| ? instantiate(parentClass.name) | ||
| ? instantiate(parentClass.alias || parentClass.name) | ||
| : parentClass.alias || parentClass.name; | ||
@@ -16,0 +16,0 @@ } |
| { | ||
| "name": "jsdoc-to-markdown", | ||
| "author": "Lloyd Brookes", | ||
| "version": "0.2.13", | ||
| "version": "0.2.14", | ||
| "description": "Markdown API documentation generator, good for Github projects", | ||
@@ -6,0 +6,0 @@ "repository": "https://github.com/75lb/jsdoc-to-markdown", |
@@ -90,3 +90,3 @@ [](https://www.npmjs.org/package/jsdoc-to-markdown) | ||
| <a name="module_jsdoc-to-markdown.onRender"></a> | ||
| ###callback: onRender | ||
| ###\~callback: onRender | ||
| Called by `jsdoc2md.render()` on completion. | ||
@@ -93,0 +93,0 @@ |
| * file-pet <sub>class</sub> | ||
| * file-pet.instie | ||
| * file-pet.files | ||
| * file-pet.delete(paths) | ||
| * [filePet.instie](#module_file-pet#instie) | ||
| * [filePet.files](#module_file-pet#files) | ||
| * [filePet.delete(paths)](#module_file-pet#delete) | ||
| * jacket <sub>class</sub> | ||
| * jacket.zip() | ||
| * [jacket.zip()](#module_jacket#zip) | ||
| * shirt | ||
| * shirt.color | ||
| * new shirt.Turtleneck() | ||
| * [shirt.color](#module_shirt.color) | ||
| * [new shirt.Turtleneck()](#module_shirt.Turtleneck) | ||
| * blazer <sub>class</sub> | ||
| * blazer.zip() | ||
| * [blazer.zip()](#module_blazer#zip) | ||
| * cattle | ||
| * cattle.createCow() | ||
| * ~innerMember | ||
| * \~innerFuction() | ||
| * ~~\~anotherInnerFuction()~~ | ||
| * [cattle.createCow()](#module_cattle.createCow) | ||
| * [\~innerMember](#module_cattle.innerMember) | ||
| * [\~innerFuction()](#module_cattle.innerFuction) | ||
| * [~~\~anotherInnerFuction()~~](#module_cattle.anotherInnerFuction) | ||
| * commonjs/cyberdyne | ||
| * cyber.createMachine() | ||
| * ~something | ||
| * \~new Machine() | ||
| * [cyber.createMachine()](#module_commonjs/cyberdyne.createMachine) | ||
| * [\~something](#module_commonjs/cyberdyne.something) | ||
| * [\~new Machine()](#module_commonjs/cyberdyne.Machine) | ||
| * file-set <sub>class</sub> | ||
| * file-set.files | ||
| * file-set.delete(paths) | ||
| * [fileSet.files](#module_file-set#files) | ||
| * [fileSet.delete(paths)](#module_file-set#delete) | ||
| * commonjs/function <sub>function</sub> | ||
| * heaven | ||
| * heaven.Cloud | ||
| * heaven.createCloud() | ||
| * \~new Cloud() | ||
| * [heaven.Cloud](#module_heaven.Cloud) | ||
| * [heaven.createCloud()](#module_heaven.createCloud) | ||
| * [\~new Cloud()](#module_heaven.Cloud) | ||
| * commonjs/ignore | ||
| * ignore.visible | ||
| * [ignore.visible](#module_commonjs/ignore.visible) | ||
| * commonjs/object-with-alias | ||
| * _.one | ||
| * _.two | ||
| * _.three() | ||
| * [_.one](#module_commonjs/object-with-alias.one) | ||
| * [_.two](#module_commonjs/object-with-alias.two) | ||
| * [_.three()](#module_commonjs/object-with-alias.three) | ||
| * commonjs/object | ||
| * object.one | ||
| * object.three(four, five) | ||
| * [object.one](#module_commonjs/object.one) | ||
| * [object.three(four, five)](#module_commonjs/object.three) | ||
| * private | ||
| * private.notprivate | ||
| * [private.notprivate](#module_private.notprivate) | ||
| * commonjs/single-value <sub>member</sub> | ||
@@ -45,50 +45,744 @@ * commonjs/sum-alias | ||
| * Globals | ||
| * eFileType <sub>enum</sub> | ||
| * visible | ||
| * variable | ||
| * typed | ||
| * types | ||
| * exampled | ||
| * examples | ||
| * _protected | ||
| * withAuthor | ||
| * hasDefault | ||
| * hasDefaultObject | ||
| * ~~deprecated~~ | ||
| * readOnly | ||
| * hasSince | ||
| * module:sum-alias(a, b) | ||
| * read(filename, done) | ||
| * globalFunc() | ||
| * exampled() | ||
| * multiExampled() | ||
| * _protected() | ||
| * withAuthor() | ||
| * ~~oldFunction()~~ | ||
| * newFunction() | ||
| * withParam(one) | ||
| * withParams(one, two) | ||
| * withOptional(one, [two]) | ||
| * withBullets(one, two) | ||
| * returnsSomething() | ||
| * returnsSomethingDesc() | ||
| * returnsSeveral() | ||
| * doSomething(options) | ||
| * doAnother(options) | ||
| * pluck(...prop) | ||
| * requirer() | ||
| * setMagicNumber(x) | ||
| * doSomething(options) | ||
| * ~~new All(input, [options])~~ | ||
| * new Person() | ||
| * new Car([options]) | ||
| * new Pipe() | ||
| * ~~new Everything(input, [options])~~ | ||
| * new Rice() | ||
| * new Something() | ||
| * new Pizza() | ||
| * new Plucker() | ||
| * CONST_ONE <sub>constant</sub> | ||
| * ~~CONST_TWO~~ <sub>constant</sub> | ||
| * callback: onComplete <sub>typedef</sub> | ||
| * type: NumberLike <sub>typedef</sub> | ||
| * [eFileType](#eFileType) <sub>enum</sub> | ||
| * [visible](#visible) | ||
| * [variable](#variable) | ||
| * [typed](#typed) | ||
| * [types](#types) | ||
| * [exampled](#exampled) | ||
| * [examples](#examples) | ||
| * [_protected](#_protected) | ||
| * [withAuthor](#withAuthor) | ||
| * [hasDefault](#hasDefault) | ||
| * [hasDefaultObject](#hasDefaultObject) | ||
| * [~~deprecated~~](#deprecated) | ||
| * [readOnly](#readOnly) | ||
| * [hasSince](#hasSince) | ||
| * [module:sum-alias(a, b)](#module_sum-alias) | ||
| * [read(filename, done)](#read) | ||
| * [globalFunc()](#globalFunc) | ||
| * [exampled()](#exampled) | ||
| * [multiExampled()](#multiExampled) | ||
| * [_protected()](#_protected) | ||
| * [withAuthor()](#withAuthor) | ||
| * [~~oldFunction()~~](#oldFunction) | ||
| * [newFunction()](#newFunction) | ||
| * [withParam(one)](#withParam) | ||
| * [withParams(one, two)](#withParams) | ||
| * [withOptional(one, [two])](#withOptional) | ||
| * [withBullets(one, two)](#withBullets) | ||
| * [returnsSomething()](#returnsSomething) | ||
| * [returnsSomethingDesc()](#returnsSomethingDesc) | ||
| * [returnsSeveral()](#returnsSeveral) | ||
| * [doSomething(options)](#doSomething) | ||
| * [doAnother(options)](#doAnother) | ||
| * [pluck(...prop)](#pluck) | ||
| * [requirer()](#requirer) | ||
| * [setMagicNumber(x)](#setMagicNumber) | ||
| * [doSomething(options)](#doSomething) | ||
| * [~~new All(input, [options])~~](#All) | ||
| * [new Person()](#Person) | ||
| * [new Car([options])](#Car) | ||
| * [new Pipe()](#Pipe) | ||
| * [~~new Everything(input, [options])~~](#Everything) | ||
| * [new Rice()](#Rice) | ||
| * [new Something()](#Something) | ||
| * [new Pizza()](#Pizza) | ||
| * [new Plucker()](#Plucker) | ||
| * [CONST_ONE](#CONST_ONE) <sub>constant</sub> | ||
| * [~~CONST_TWO~~](#CONST_TWO) <sub>constant</sub> | ||
| * [callback: onComplete](#onComplete) <sub>typedef</sub> | ||
| * [type: NumberLike](#NumberLike) <sub>typedef</sub> | ||
| <a name="module_file-pet"></a> | ||
| ##file-pet | ||
| this module returns a pet of files | ||
| **Example** | ||
| ```js | ||
| var cowFiles = FilePet("cow/*"); | ||
| ``` | ||
| <a name="module_file-pet#instie"></a> | ||
| ###filePet.instie | ||
| an instance ting | ||
| <a name="module_file-pet#files"></a> | ||
| ###filePet.files | ||
| the static property | ||
| <a name="module_file-pet#delete"></a> | ||
| ###filePet.delete(paths) | ||
| A static methy meth | ||
| **Params** | ||
| - paths `array` - the paths to delete | ||
| <a name="module_jacket"></a> | ||
| ##jacket | ||
| A module representing a jacket. | ||
| <a name="module_jacket#zip"></a> | ||
| ###jacket.zip() | ||
| Open and close your Jacket. | ||
| <a name="module_shirt"></a> | ||
| ##shirt | ||
| **Version**: 1.0 | ||
| A module representing a shirt. | ||
| <a name="module_shirt.color"></a> | ||
| ###shirt.color | ||
| A property of the module. | ||
| <a name="module_shirt.Turtleneck"></a> | ||
| ##class: Turtleneck | ||
| <a name="module_shirt.Turtleneck"></a> | ||
| ###new shirt.Turtleneck() | ||
| **Params** | ||
| - `number` - the size innit | ||
| <a name="module_shirt.Turtleneck#size"></a> | ||
| ###turtleneck.size | ||
| A property of the class. | ||
| <a name="module_blazer"></a> | ||
| ##blazer | ||
| A module representing a blazer. | ||
| <a name="module_blazer#zip"></a> | ||
| ###blazer.zip() | ||
| Open and close your Blazer. | ||
| <a name="module_cattle"></a> | ||
| ##cattle | ||
| exported object, with-inner-members | ||
| <a name="module_cattle.createCow"></a> | ||
| ###cattle.createCow() | ||
| **Returns**: `boolean` | ||
| <a name="module_cattle.innerMember"></a> | ||
| ###\~innerMember | ||
| the inner member | ||
| **Scope**: inner member of [cattle](#module_cattle) | ||
| <a name="module_cattle.innerFuction"></a> | ||
| ###\~innerFuction() | ||
| the inner function | ||
| **Scope**: inner function of [cattle](#module_cattle) | ||
| <a name="module_cattle.anotherInnerFuction"></a> | ||
| ###~~\~anotherInnerFuction()~~ | ||
| another inner function | ||
| ***Deprecated*** | ||
| **Scope**: inner function of [cattle](#module_cattle) | ||
| <a name="module_commonjs/cyberdyne"></a> | ||
| ##commonjs/cyberdyne | ||
| exports an object.. has an inner class. | ||
| <a name="module_commonjs/cyberdyne.createMachine"></a> | ||
| ###cyber.createMachine() | ||
| **Returns**: `module:cyberdyne~Machine` | ||
| <a name="module_commonjs/cyberdyne.something"></a> | ||
| ###\~something | ||
| random | ||
| **Scope**: inner member of [commonjs/cyberdyne](#module_commonjs/cyberdyne) | ||
| <a name="module_commonjs/cyberdyne.Machine"></a> | ||
| ##class: Machine | ||
| The main class of machine | ||
| **Scope**: inner class of [commonjs/cyberdyne](#module_commonjs/cyberdyne) | ||
| <a name="module_commonjs/cyberdyne.Machine#eyes"></a> | ||
| ###machine.eyes | ||
| **Type**: `number` | ||
| <a name="module_commonjs/cyberdyne.Machine#vibe"></a> | ||
| ###machine.vibe | ||
| **Type**: `string` | ||
| <a name="module_file-set"></a> | ||
| ##file-set | ||
| **Example** | ||
| ```js | ||
| var fileSet = require("file-set"); | ||
| ``` | ||
| <a name="module_file-set#files"></a> | ||
| ###fileSet.files | ||
| the static property | ||
| <a name="module_file-set#delete"></a> | ||
| ###fileSet.delete(paths) | ||
| A static methy meth | ||
| **Params** | ||
| - paths `array` - the paths to delete | ||
| <a name="module_commonjs/function"></a> | ||
| ##commonjs/function | ||
| **Author**: Lloyd <75pound@gmail.com> | ||
| This is the module description | ||
| **Since**: v0.10.28 | ||
| <a name="module_heaven"></a> | ||
| ##heaven | ||
| factory module creating dodgy cloud. object-with-static-class. | ||
| <a name="module_heaven.Cloud"></a> | ||
| ###heaven.Cloud | ||
| access to the Cloud class | ||
| **Type**: `module:heaven~Cloud` | ||
| <a name="module_heaven.createCloud"></a> | ||
| ###heaven.createCloud() | ||
| **Returns**: [Cloud](#module_heaven.Cloud) | ||
| <a name="module_heaven.Cloud"></a> | ||
| ##class: Cloud | ||
| The main class of machine | ||
| **Scope**: inner class of [heaven](#module_heaven) | ||
| <a name="module_heaven.Cloud#eyes"></a> | ||
| ###cloud.eyes | ||
| **Type**: `number` | ||
| <a name="module_heaven.Cloud#vibe"></a> | ||
| ###cloud.vibe | ||
| **Type**: `string` | ||
| <a name="module_commonjs/ignore"></a> | ||
| ##commonjs/ignore | ||
| module with ignored shiz | ||
| <a name="module_commonjs/ignore.visible"></a> | ||
| ###ignore.visible | ||
| visible property | ||
| <a name="module_commonjs/object-with-alias"></a> | ||
| ##commonjs/object-with-alias | ||
| simple object export | ||
| <a name="module_commonjs/object-with-alias.one"></a> | ||
| ###_.one | ||
| first property | ||
| <a name="module_commonjs/object-with-alias.two"></a> | ||
| ###_.two | ||
| second property | ||
| <a name="module_commonjs/object-with-alias.three"></a> | ||
| ###_.three() | ||
| a function | ||
| <a name="module_commonjs/object"></a> | ||
| ##commonjs/object | ||
| simple object export | ||
| <a name="module_commonjs/object.one"></a> | ||
| ###object.one | ||
| first property | ||
| <a name="module_commonjs/object.three"></a> | ||
| ###object.three(four, five) | ||
| a function | ||
| **Params** | ||
| - four `string` - The input string | ||
| - five `object` - a second input | ||
| **Since**: v0.10.28 | ||
| **Author**: Lloyd <75pound@gmail.com> | ||
| **Returns**: `object` | `string` - this return has several types | ||
| **Example** | ||
| ```js | ||
| allTogether(true); | ||
| ``` | ||
| <a name="module_private"></a> | ||
| ##private | ||
| module with private shiz | ||
| <a name="module_private.notprivate"></a> | ||
| ###private.notprivate | ||
| visible property | ||
| <a name="module_commonjs/single-value"></a> | ||
| ##commonjs/single-value | ||
| this module exports one value, that's it | ||
| <a name="module_commonjs/sum-alias"></a> | ||
| ##commonjs/sum-alias | ||
| A simple maths function | ||
| **Example** | ||
| ```js | ||
| var sum = require("sum"); | ||
| ``` | ||
| <a name="module_commonjs/sum"></a> | ||
| ##commonjs/sum(a, b) | ||
| A simple maths function | ||
| **Params** | ||
| - a `number` - first number | ||
| - b `number` - second number | ||
| **Returns**: `number` - the result | ||
| **Example** | ||
| ```js | ||
| var sum = require("sum"); | ||
| var result = sum(1, 1); | ||
| ``` | ||
| ##Global scope | ||
| <a name="CONST_ONE"></a> | ||
| ###CONST_ONE | ||
| the first important constant | ||
| **Type**: `number` | ||
| <a name="CONST_TWO"></a> | ||
| ###~~CONST_TWO~~ | ||
| This variable has all tags set | ||
| ***Deprecated*** | ||
| **Read only**: true | ||
| **Type**: `boolean` | ||
| **Since**: v0.10.28 | ||
| **Author**: Lloyd Brookes <lloyd@brookes.com> | ||
| **Example** | ||
| ```js | ||
| var CONST_TWO = true; | ||
| ``` | ||
| <a name="eFileType"></a> | ||
| ###eFileType | ||
| Enum for the `type` value | ||
| **Enum** with properties: `NOEXIST`, `FILE`, `DIR` | ||
| **Read only**: true | ||
| **Type**: `number` | ||
| <a name="visible"></a> | ||
| ###visible | ||
| a visible global | ||
| <a name="variable"></a> | ||
| ###variable | ||
| a global variable | ||
| <a name="typed"></a> | ||
| ###typed | ||
| **Type**: `string` | ||
| <a name="types"></a> | ||
| ###types | ||
| **Type**: `string | number` | ||
| <a name="exampled"></a> | ||
| ###exampled | ||
| a var with an example | ||
| **Example** | ||
| ```js | ||
| var another = 100; | ||
| ``` | ||
| <a name="examples"></a> | ||
| ###examples | ||
| a var with multiple examples | ||
| **Example** | ||
| ```js | ||
| var another = 100; | ||
| ``` | ||
| **Example** | ||
| ```js | ||
| var next = "p"; | ||
| ``` | ||
| <a name="_protected"></a> | ||
| ###_protected | ||
| **Access**: protected | ||
| <a name="withAuthor"></a> | ||
| ###withAuthor | ||
| **Author**: Clive Jones <clive@jones.com> | ||
| <a name="hasDefault"></a> | ||
| ###hasDefault | ||
| **Default**: `23` | ||
| <a name="hasDefaultObject"></a> | ||
| ###hasDefaultObject | ||
| **Default**: `{"one":1,"two":2}` | ||
| <a name="deprecated"></a> | ||
| ###~~deprecated~~ | ||
| ***Deprecated*** | ||
| <a name="readOnly"></a> | ||
| ###readOnly | ||
| **Read only**: true | ||
| <a name="hasSince"></a> | ||
| ###hasSince | ||
| **Since**: v0.10.28 | ||
| <a name="module_sum-alias"></a> | ||
| ###module:sum-alias(a, b) | ||
| Sums two numbers together | ||
| **Params** | ||
| - a `number` - first number | ||
| - b `number` - second number | ||
| **Returns**: `number` - the result | ||
| **Example** | ||
| ```js | ||
| var result = sum(1, 1); | ||
| ``` | ||
| <a name="read"></a> | ||
| ###read(filename, done) | ||
| **Params** | ||
| - filename `string` - the filename | ||
| - done [onComplete](#onComplete) - the callback | ||
| <a name="globalFunc"></a> | ||
| ###globalFunc() | ||
| a global function | ||
| <a name="exampled"></a> | ||
| ###exampled() | ||
| a function with an example | ||
| **Example** | ||
| ```js | ||
| var result = exampled(); | ||
| ``` | ||
| <a name="multiExampled"></a> | ||
| ###multiExampled() | ||
| a function with multiple examples | ||
| **Example** | ||
| ```js | ||
| var another = 100; | ||
| ``` | ||
| **Example** | ||
| ```js | ||
| var next = "p"; | ||
| ``` | ||
| <a name="_protected"></a> | ||
| ###_protected() | ||
| **Access**: protected | ||
| <a name="withAuthor"></a> | ||
| ###withAuthor() | ||
| **Author**: Clive Jones <clive@jones.com> | ||
| <a name="oldFunction"></a> | ||
| ###~~oldFunction()~~ | ||
| ***Deprecated*** | ||
| <a name="newFunction"></a> | ||
| ###newFunction() | ||
| **Since**: v0.10.28 | ||
| <a name="withParam"></a> | ||
| ###withParam(one) | ||
| **Params** | ||
| - one `string` - The input string | ||
| <a name="withParams"></a> | ||
| ###withParams(one, two) | ||
| **Params** | ||
| - one `string` - The input string | ||
| - two `object` | ||
| <a name="withOptional"></a> | ||
| ###withOptional(one, [two]) | ||
| **Params** | ||
| - one `string` - The input string | ||
| - [two] `object` - this one is optional | ||
| <a name="withBullets"></a> | ||
| ###withBullets(one, two) | ||
| this description has | ||
| - bullet | ||
| - points | ||
| and needs this line to separate the above list from the below | ||
| **Params** | ||
| - one `string` - The input string | ||
| - two `object` - a second input | ||
| <a name="returnsSomething"></a> | ||
| ###returnsSomething() | ||
| **Returns**: `string` | ||
| <a name="returnsSomethingDesc"></a> | ||
| ###returnsSomethingDesc() | ||
| **Returns**: `object` - this return has a description | ||
| <a name="returnsSeveral"></a> | ||
| ###returnsSeveral() | ||
| **Returns**: `object` | `string` - this return has several types | ||
| <a name="doSomething"></a> | ||
| ###doSomething(options) | ||
| **Params** | ||
| - options `object` - the function options | ||
| - one `string` - first option | ||
| - two `string` - second option | ||
| <a name="doAnother"></a> | ||
| ###doAnother(options) | ||
| **Params** | ||
| - options `Object` - the function options | ||
| <a name="pluck"></a> | ||
| ###pluck(...prop) | ||
| This function takes variable input | ||
| **Params** | ||
| - ...prop `string` - the property(s) as input | ||
| <a name="requirer"></a> | ||
| ###requirer() | ||
| ensure you have some-module installed | ||
| <a name="setMagicNumber"></a> | ||
| ###setMagicNumber(x) | ||
| Set the magic number. | ||
| **Params** | ||
| - x [NumberLike](#NumberLike) - The magic number. | ||
| <a name="doSomething"></a> | ||
| ###doSomething(options) | ||
| **Params** | ||
| - options `object` - the function options | ||
| - one `string` - first option | ||
| - two `string` - second option | ||
| <a name="All"></a> | ||
| ##class: All | ||
| a class with all of the things | ||
| **Extends**: `Number` | ||
| <a name="All"></a> | ||
| ###~~new All(input, [options])~~ | ||
| the constructor description | ||
| **Params** | ||
| - input `object` - an input | ||
| - [options] `object` - optional shit | ||
| ***Deprecated*** | ||
| **Since**: v0.10.28 | ||
| **Author**: 75lb <75pound@gmail.com> | ||
| **Example** | ||
| ```js | ||
| var yeah = new Everything(true); | ||
| ``` | ||
| <a name="All#topping"></a> | ||
| ###all.topping | ||
| the ingredients on top | ||
| **Default**: `mud, lettuce` | ||
| **Type**: `string` | ||
| **Since**: v1.0.0 | ||
| <a name="All#size"></a> | ||
| ###all.size | ||
| the general size | ||
| <a name="All#allThings"></a> | ||
| ###~~all.allThings(one, two)~~ | ||
| This function has all tags set | ||
| **Params** | ||
| - one `string` - The input string | ||
| - two `object` - a second input | ||
| ***Deprecated*** | ||
| **Since**: v0.10.28 | ||
| **Author**: Lloyd <75pound@gmail.com> | ||
| **Returns**: `object` | `string` - this return has several types | ||
| **Example** | ||
| ```js | ||
| all.allTogether(true); | ||
| ``` | ||
| <a name="Person"></a> | ||
| ##class: Person | ||
| simple class description | ||
| **Extends**: `Object` | ||
| <a name="Person"></a> | ||
| ###new Person() | ||
| a constructor description | ||
| <a name="Car"></a> | ||
| ##class: Car | ||
| <a name="Car"></a> | ||
| ###new Car([options]) | ||
| a constructor with args | ||
| **Params** | ||
| - [options] `object` - optional shit | ||
| <a name="Pipe"></a> | ||
| ##class: Pipe | ||
| a class which extends | ||
| **Extends**: `Pipe` | ||
| <a name="Everything"></a> | ||
| ##class: Everything | ||
| a class with all trimmings | ||
| **Extends**: `Pipe` | ||
| <a name="Everything"></a> | ||
| ###~~new Everything(input, [options])~~ | ||
| the constructor description | ||
| **Params** | ||
| - input `object` - an input | ||
| - [options] `object` - optional shit | ||
| ***Deprecated*** | ||
| **Since**: v0.10.28 | ||
| **Author**: 75lb <75pound@gmail.com> | ||
| **Example** | ||
| ```js | ||
| var yeah = new Everything(true); | ||
| ``` | ||
| <a name="Rice"></a> | ||
| ##class: Rice | ||
| ###event: "cooked" | ||
| Fired when rice is ready | ||
| ###event: "cooking" | ||
| Fired when rice is cooking | ||
| <a name="Something"></a> | ||
| ##class: Something | ||
| <a name="Something#methodOne"></a> | ||
| ###something.methodOne() | ||
| method description | ||
| <a name="Something#allTogether"></a> | ||
| ###~~something.allTogether(one, two)~~ | ||
| This function has all tags set | ||
| **Params** | ||
| - one `string` - The input string | ||
| - two `object` - a second input | ||
| ***Deprecated*** | ||
| **Since**: v0.10.28 | ||
| **Author**: Lloyd <75pound@gmail.com> | ||
| **Returns**: `object` | `string` - this return has several types | ||
| **Example** | ||
| ```js | ||
| something.allTogether(true); | ||
| ``` | ||
| <a name="Pizza"></a> | ||
| ##class: Pizza | ||
| <a name="Pizza#topping"></a> | ||
| ###pizza.topping | ||
| the ingredients on top | ||
| **Default**: `mud, lettuce` | ||
| **Type**: `string` | ||
| **Since**: v1.0.0 | ||
| <a name="Pizza#size"></a> | ||
| ###pizza.size | ||
| the general size | ||
| <a name="Plucker"></a> | ||
| ##class: Plucker | ||
| <a name="Plucker#doPluck"></a> | ||
| ###plucker.doPluck(one, ...args, ...three) | ||
| This function takes variable input | ||
| **Params** | ||
| - one `string` - an input | ||
| - ...args `string` - the property(s) as input | ||
| - ...three `string` - more input | ||
| <a name="onComplete"></a> | ||
| ###callback: onComplete | ||
| Called when an async operation completes | ||
| **Params** | ||
| - err `object` - an error, or `null` | ||
| - result `string` - the result info | ||
| **Type**: `function` | ||
| <a name="NumberLike"></a> | ||
| ###type: NumberLike | ||
| A number, or a string containing a number. | ||
| **Type**: `number | string` |
| <a name="module_file-pet"></a> | ||
| #file-pet | ||
| ##file-pet | ||
@@ -11,4 +11,9 @@ this module returns a pet of files | ||
| ``` | ||
| **Symbols** | ||
| * [filePet.instie](#module_file-pet#instie) | ||
| * [filePet.files](#module_file-pet#files) | ||
| * [filePet.delete(paths)](#module_file-pet#delete) | ||
| <a name="module_file-pet#instie"></a> | ||
| ###file-pet.instie | ||
| ###filePet.instie | ||
| an instance ting | ||
@@ -18,3 +23,3 @@ | ||
| <a name="module_file-pet#files"></a> | ||
| ###file-pet.files | ||
| ###filePet.files | ||
| the static property | ||
@@ -24,3 +29,3 @@ | ||
| <a name="module_file-pet#delete"></a> | ||
| ###file-pet.delete(paths) | ||
| ###filePet.delete(paths) | ||
| A static methy meth | ||
@@ -27,0 +32,0 @@ |
| <a name="module_file-pet"></a> | ||
| #file-pet | ||
| ##file-pet | ||
@@ -12,9 +12,8 @@ this module returns a pet of files | ||
| **Symbols** | ||
| * [filePet.instie](#module_file-pet#instie) | ||
| * [filePet.files](#module_file-pet#files) | ||
| * [filePet.delete(paths)](#module_file-pet#delete) | ||
| * [instie](#module_file-pet#instie) | ||
| * [files](#module_file-pet#files) | ||
| * [delete(paths)](#module_file-pet#delete) | ||
| <a name="module_file-pet#instie"></a> | ||
| ###file-pet.instie | ||
| ###filePet.instie | ||
| an instance ting | ||
@@ -24,3 +23,3 @@ | ||
| <a name="module_file-pet#files"></a> | ||
| ###file-pet.files | ||
| ###filePet.files | ||
| the static property | ||
@@ -30,3 +29,3 @@ | ||
| <a name="module_file-pet#delete"></a> | ||
| ###file-pet.delete(paths) | ||
| ###filePet.delete(paths) | ||
| A static methy meth | ||
@@ -33,0 +32,0 @@ |
| <a name="module_jacket"></a> | ||
| #jacket | ||
| ##jacket | ||
@@ -7,2 +7,5 @@ A module representing a jacket. | ||
| **Symbols** | ||
| * [jacket.zip()](#module_jacket#zip) | ||
| <a name="module_jacket#zip"></a> | ||
@@ -9,0 +12,0 @@ ###jacket.zip() |
| <a name="module_shirt"></a> | ||
| #shirt | ||
| ##shirt | ||
| **Version**: 1.0 | ||
@@ -8,2 +8,6 @@ | ||
| **Symbols** | ||
| * [shirt.color](#module_shirt.color) | ||
| * [new shirt.Turtleneck()](#module_shirt.Turtleneck) | ||
| <a name="module_shirt.color"></a> | ||
@@ -23,2 +27,5 @@ ###shirt.color | ||
| **Symbols** | ||
| * [turtleneck.size](#module_shirt.Turtleneck#size) | ||
| <a name="module_shirt.Turtleneck#size"></a> | ||
@@ -29,2 +36,1 @@ ###turtleneck.size | ||
| #Global scope |
| <a name="module_blazer"></a> | ||
| #blazer | ||
| ##blazer | ||
@@ -7,2 +7,5 @@ A module representing a blazer. | ||
| **Symbols** | ||
| * [blazer.zip()](#module_blazer#zip) | ||
| <a name="module_blazer#zip"></a> | ||
@@ -9,0 +12,0 @@ ###blazer.zip() |
| <a name="module_cattle"></a> | ||
| #cattle | ||
| ##cattle | ||
@@ -7,2 +7,8 @@ exported object, with-inner-members | ||
| **Symbols** | ||
| * [cattle.createCow()](#module_cattle.createCow) | ||
| * [\~innerMember](#module_cattle.innerMember) | ||
| * [\~innerFuction()](#module_cattle.innerFuction) | ||
| * [~~\~anotherInnerFuction()~~](#module_cattle.anotherInnerFuction) | ||
| <a name="module_cattle.createCow"></a> | ||
@@ -12,3 +18,3 @@ ###cattle.createCow() | ||
| <a name="module_cattle.innerMember"></a> | ||
| ###~innerMember | ||
| ###\~innerMember | ||
| the inner member | ||
@@ -15,0 +21,0 @@ |
| <a name="module_cyberdyne"></a> | ||
| #cyberdyne | ||
| ##cyberdyne | ||
@@ -7,2 +7,7 @@ exports an object.. has an inner class. | ||
| **Symbols** | ||
| * [cyber.createMachine()](#module_cyberdyne.createMachine) | ||
| * [\~something](#module_cyberdyne.something) | ||
| * [\~new Machine()](#module_cyberdyne.Machine) | ||
| <a name="module_cyberdyne.createMachine"></a> | ||
@@ -12,3 +17,3 @@ ###cyber.createMachine() | ||
| <a name="module_cyberdyne.something"></a> | ||
| ###~something | ||
| ###\~something | ||
| random | ||
@@ -24,2 +29,6 @@ | ||
| **Scope**: inner class of [cyberdyne](#module_cyberdyne) | ||
| **Symbols** | ||
| * [machine.eyes](#module_cyberdyne.Machine#eyes) | ||
| * [machine.vibe](#module_cyberdyne.Machine#vibe) | ||
| <a name="module_cyberdyne.Machine#eyes"></a> | ||
@@ -26,0 +35,0 @@ ###machine.eyes |
| <a name="module_file-set"></a> | ||
| #file-set | ||
| ##file-set | ||
@@ -9,4 +9,8 @@ | ||
| ``` | ||
| **Symbols** | ||
| * [fileSet.files](#module_file-set#files) | ||
| * [fileSet.delete(paths)](#module_file-set#delete) | ||
| <a name="module_file-set#files"></a> | ||
| ###file-set.files | ||
| ###fileSet.files | ||
| the static property | ||
@@ -16,3 +20,3 @@ | ||
| <a name="module_file-set#delete"></a> | ||
| ###file-set.delete(paths) | ||
| ###fileSet.delete(paths) | ||
| A static methy meth | ||
@@ -19,0 +23,0 @@ |
| <a name="module_file-set"></a> | ||
| #file-set | ||
| ##file-set | ||
@@ -10,8 +10,7 @@ | ||
| **Symbols** | ||
| * [fileSet.files](#module_file-set#files) | ||
| * [fileSet.delete(paths)](#module_file-set#delete) | ||
| * [files](#module_file-set#files) | ||
| * [delete(paths)](#module_file-set#delete) | ||
| <a name="module_file-set#files"></a> | ||
| ###file-set.files | ||
| ###fileSet.files | ||
| the static property | ||
@@ -21,3 +20,3 @@ | ||
| <a name="module_file-set#delete"></a> | ||
| ###file-set.delete(paths) | ||
| ###fileSet.delete(paths) | ||
| A static methy meth | ||
@@ -24,0 +23,0 @@ |
| <a name="module_function"></a> | ||
| #function | ||
| ##function | ||
| **Author**: Lloyd <75pound@gmail.com> | ||
@@ -9,1 +9,3 @@ | ||
| **Symbols** | ||
| <a name="module_heaven"></a> | ||
| #heaven | ||
| ##heaven | ||
@@ -7,2 +7,7 @@ factory module creating dodgy cloud. object-with-static-class. | ||
| **Symbols** | ||
| * [heaven.Cloud](#module_heaven.Cloud) | ||
| * [heaven.createCloud()](#module_heaven.createCloud) | ||
| * [\~new Cloud()](#module_heaven.Cloud) | ||
| <a name="module_heaven.Cloud"></a> | ||
@@ -22,2 +27,6 @@ ###heaven.Cloud | ||
| **Scope**: inner class of [heaven](#module_heaven) | ||
| **Symbols** | ||
| * [cloud.eyes](#module_heaven.Cloud#eyes) | ||
| * [cloud.vibe](#module_heaven.Cloud#vibe) | ||
| <a name="module_heaven.Cloud#eyes"></a> | ||
@@ -24,0 +33,0 @@ ###cloud.eyes |
| <a name="module_ignore"></a> | ||
| #ignore | ||
| ##ignore | ||
@@ -7,2 +7,5 @@ module with ignored shiz | ||
| **Symbols** | ||
| * [ignore.visible](#module_ignore.visible) | ||
| <a name="module_ignore.visible"></a> | ||
@@ -9,0 +12,0 @@ ###ignore.visible |
| <a name="module_object-with-alias"></a> | ||
| #object-with-alias | ||
| ##object-with-alias | ||
@@ -7,2 +7,7 @@ simple object export | ||
| **Symbols** | ||
| * [_.one](#module_object-with-alias.one) | ||
| * [_.two](#module_object-with-alias.two) | ||
| * [_.three()](#module_object-with-alias.three) | ||
| <a name="module_object-with-alias.one"></a> | ||
@@ -9,0 +14,0 @@ ###_.one |
| <a name="module_object"></a> | ||
| #object | ||
| ##object | ||
@@ -8,7 +8,5 @@ simple object export | ||
| **Symbols** | ||
| * [object.one](#module_object.one) | ||
| * [object.three(four, five)](#module_object.three) | ||
| * [one](#module_object.one) | ||
| * [two](#module_object.two) | ||
| * [three(four, five)](#module_object.three) | ||
| <a name="module_object.one"></a> | ||
@@ -15,0 +13,0 @@ ###object.one |
| <a name="module_object"></a> | ||
| #object | ||
| ##object | ||
@@ -7,2 +7,6 @@ simple object export | ||
| **Symbols** | ||
| * [object.one](#module_object.one) | ||
| * [object.three(four, five)](#module_object.three) | ||
| <a name="module_object.one"></a> | ||
@@ -9,0 +13,0 @@ ###object.one |
| <a name="module_private"></a> | ||
| #private | ||
| ##private | ||
@@ -7,2 +7,5 @@ module with private shiz | ||
| **Symbols** | ||
| * [private.notprivate](#module_private.notprivate) | ||
| <a name="module_private.notprivate"></a> | ||
@@ -9,0 +12,0 @@ ###private.notprivate |
| <a name="module_single-value"></a> | ||
| #single-value | ||
| ##single-value | ||
@@ -7,1 +7,3 @@ this module exports one value, that's it | ||
| **Symbols** | ||
| <a name="module_sum-alias"></a> | ||
| #sum-alias | ||
| ##sum-alias | ||
@@ -11,1 +11,3 @@ A simple maths function | ||
| ``` | ||
| **Symbols** | ||
| <a name="module_sum"></a> | ||
| #sum(a, b) | ||
| ##sum(a, b) | ||
@@ -18,1 +18,3 @@ A simple maths function | ||
| ``` | ||
| **Symbols** | ||
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="CONST_ONE"></a> | ||
@@ -12,3 +12,2 @@ ###CONST_ONE | ||
| ***Deprecated*** | ||
| **Access**: private | ||
| **Read only**: true | ||
@@ -71,6 +70,2 @@ **Type**: `boolean` | ||
| <a name="_private"></a> | ||
| ###_private | ||
| **Access**: private | ||
| <a name="withAuthor"></a> | ||
@@ -100,17 +95,2 @@ ###withAuthor | ||
| **Since**: v0.10.28 | ||
| <a name="allTogether"></a> | ||
| ###~~allTogether~~ | ||
| This variable has all tags set | ||
| ***Deprecated*** | ||
| **Access**: private | ||
| **Default**: `false` | ||
| **Read only**: true | ||
| **Type**: `boolean` | ||
| **Since**: v0.10.28 | ||
| **Author**: 75lb <75pound@gmail.com> | ||
| **Example** | ||
| ```js | ||
| var allTogether = true; | ||
| ``` | ||
| <a name="read"></a> | ||
@@ -150,5 +130,2 @@ ###read(filename, done) | ||
| **Access**: protected | ||
| <a name="_private"></a> | ||
| ###_private() | ||
| **Access**: private | ||
| <a name="withAuthor"></a> | ||
@@ -206,20 +183,2 @@ ###withAuthor() | ||
| **Returns**: `object` | `string` - this return has several types | ||
| <a name="allTogether"></a> | ||
| ###~~allTogether(one, two)~~ | ||
| This function has all tags set | ||
| **Params** | ||
| - one `string` - The input string | ||
| - two `object` - a second input | ||
| ***Deprecated*** | ||
| **Access**: private | ||
| **Since**: v0.10.28 | ||
| **Author**: Lloyd <75pound@gmail.com> | ||
| **Returns**: `object` | `string` - this return has several types | ||
| **Example** | ||
| ```js | ||
| allTogether(true); | ||
| ``` | ||
| <a name="doSomething"></a> | ||
@@ -226,0 +185,0 @@ ###doSomething(options) |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="read"></a> | ||
@@ -3,0 +3,0 @@ ###read(filename, done) |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="All"></a> | ||
@@ -24,2 +24,7 @@ | ||
| ``` | ||
| **Symbols** | ||
| * [all.topping](#All#topping) | ||
| * [all.size](#All#size) | ||
| * [~~all.allThings(one, two)~~](#All#allThings) | ||
| <a name="All#topping"></a> | ||
@@ -26,0 +31,0 @@ ###all.topping |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="Person"></a> | ||
@@ -12,2 +12,4 @@ | ||
| **Symbols** | ||
| <a name="Car"></a> | ||
@@ -24,2 +26,4 @@ | ||
| **Symbols** | ||
| <a name="Pipe"></a> | ||
@@ -31,2 +35,4 @@ | ||
| **Extends**: `Pipe` | ||
| **Symbols** | ||
| <a name="Everything"></a> | ||
@@ -54,1 +60,3 @@ | ||
| ``` | ||
| **Symbols** | ||
@@ -1,5 +0,7 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="Rice"></a> | ||
| ##class: Rice | ||
| **Symbols** | ||
| ###event: "cooked" | ||
@@ -6,0 +8,0 @@ Fired when rice is ready |
@@ -1,5 +0,9 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="Something"></a> | ||
| ##class: Something | ||
| **Symbols** | ||
| * [something.methodOne()](#Something#methodOne) | ||
| * [~~something.allTogether(one, two)~~](#Something#allTogether) | ||
| <a name="Something#methodOne"></a> | ||
@@ -6,0 +10,0 @@ ###something.methodOne() |
@@ -1,5 +0,9 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="Pizza"></a> | ||
| ##class: Pizza | ||
| **Symbols** | ||
| * [pizza.topping](#Pizza#topping) | ||
| * [pizza.size](#Pizza#size) | ||
| <a name="Pizza#topping"></a> | ||
@@ -6,0 +10,0 @@ ###pizza.topping |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="CONST_ONE"></a> | ||
@@ -12,3 +12,2 @@ ###CONST_ONE | ||
| ***Deprecated*** | ||
| **Access**: private | ||
| **Read only**: true | ||
@@ -15,0 +14,0 @@ **Type**: `boolean` |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="eFileType"></a> | ||
@@ -3,0 +3,0 @@ ###eFileType |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="globalFunc"></a> | ||
@@ -29,5 +29,2 @@ ###globalFunc() | ||
| **Access**: protected | ||
| <a name="_private"></a> | ||
| ###_private() | ||
| **Access**: private | ||
| <a name="withAuthor"></a> | ||
@@ -85,19 +82,1 @@ ###withAuthor() | ||
| **Returns**: `object` | `string` - this return has several types | ||
| <a name="allTogether"></a> | ||
| ###~~allTogether(one, two)~~ | ||
| This function has all tags set | ||
| **Params** | ||
| - one `string` - The input string | ||
| - two `object` - a second input | ||
| ***Deprecated*** | ||
| **Access**: private | ||
| **Since**: v0.10.28 | ||
| **Author**: Lloyd <75pound@gmail.com> | ||
| **Returns**: `object` | `string` - this return has several types | ||
| **Example** | ||
| ```js | ||
| allTogether(true); | ||
| ``` |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="visible"></a> | ||
@@ -3,0 +3,0 @@ ###visible |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="variable"></a> | ||
@@ -39,6 +39,2 @@ ###variable | ||
| <a name="_private"></a> | ||
| ###_private | ||
| **Access**: private | ||
| <a name="withAuthor"></a> | ||
@@ -68,16 +64,1 @@ ###withAuthor | ||
| **Since**: v0.10.28 | ||
| <a name="allTogether"></a> | ||
| ###~~allTogether~~ | ||
| This variable has all tags set | ||
| ***Deprecated*** | ||
| **Access**: private | ||
| **Default**: `false` | ||
| **Read only**: true | ||
| **Type**: `boolean` | ||
| **Since**: v0.10.28 | ||
| **Author**: 75lb <75pound@gmail.com> | ||
| **Example** | ||
| ```js | ||
| var allTogether = true; | ||
| ``` |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="doSomething"></a> | ||
@@ -3,0 +3,0 @@ ###doSomething(options) |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="pluck"></a> | ||
@@ -13,2 +13,5 @@ ###pluck(...prop) | ||
| ##class: Plucker | ||
| **Symbols** | ||
| * [plucker.doPluck(one, ...args, ...three)](#Plucker#doPluck) | ||
| <a name="Plucker#doPluck"></a> | ||
@@ -15,0 +18,0 @@ ###plucker.doPluck(one, ...args, ...three) |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="requirer"></a> | ||
@@ -3,0 +3,0 @@ ###requirer() |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="setMagicNumber"></a> | ||
@@ -3,0 +3,0 @@ ###setMagicNumber(x) |
@@ -1,2 +0,2 @@ | ||
| #Global scope | ||
| ##Global scope | ||
| <a name="doSomething"></a> | ||
@@ -3,0 +3,0 @@ ###doSomething(options) |
@@ -22,3 +22,4 @@ "use strict"; | ||
| path.join("test/input/commonjs", file), | ||
| path.join("test/output/commonjs", path.basename(file, ".js") + ".md") | ||
| path.join("test/output/commonjs", path.basename(file, ".js") + ".md"), | ||
| null, true | ||
| ); | ||
@@ -30,3 +31,4 @@ }); | ||
| path.join("test/input/amd", file), | ||
| path.join("test/output/amd", path.basename(file, ".js") + ".md") | ||
| path.join("test/output/amd", path.basename(file, ".js") + ".md"), | ||
| null, true | ||
| ); | ||
@@ -38,3 +40,4 @@ }); | ||
| path.join("test/input/globals", file), | ||
| path.join("test/output/globals", path.basename(file, ".js") + ".md") | ||
| path.join("test/output/globals", path.basename(file, ".js") + ".md"), | ||
| null, true | ||
| ); | ||
@@ -44,4 +47,4 @@ }); | ||
| render("test/input/globals/*.js", "test/output/globals/all.md"); | ||
| render("test/input/commonjs/object.js", "test/output/commonjs/object-with-index.md", "modules", true); | ||
| render("test/input/commonjs/file-set.js", "test/output/commonjs/fileset-with-index.md", "modules", true); | ||
| render("test/input/amd/file-pet.js", "test/output/amd/filepet-with-index.md", "modules", true); | ||
| render("test/input/commonjs/object.js", "test/output/commonjs/object-with-index.md", null, true); | ||
| render("test/input/commonjs/file-set.js", "test/output/commonjs/fileset-with-index.md", null, true); | ||
| render("test/input/amd/file-pet.js", "test/output/amd/filepet-with-index.md", null, true); |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by21.7%
85228
- Number of package files
- increased by1.32%
153
- Lines of code
- increased by0.28%
1082
No dependency changes