From dc5c56a24ce62f34e69c2f35f82dc0734e729f6b Mon Sep 17 00:00:00 2001 From: Ryuichi Okumura Date: Thu, 30 Jul 2015 21:10:55 +0900 Subject: [PATCH] Build docs --- docs/args/partials/help.mustache | 2 +- output/api/classes/CLI.html | 2 +- output/api/classes/DocBuilder.html | 156 +++++----- output/api/classes/DocParser.html | 336 ++++++++++---------- output/api/classes/DocView.html | 2 +- output/api/classes/Files.html | 2 +- output/api/classes/Help.html | 54 ++-- output/api/classes/Main.html | 2 +- output/api/classes/Options.html | 2 +- output/api/classes/Server.html | 54 ++-- output/api/classes/Utils.html | 2 +- output/api/classes/YUIDoc.html | 414 ++++++++++++------------- output/api/data.json | 2 +- output/api/files/lib_builder.js.html | 2 +- output/api/files/lib_cli.js.html | 2 +- output/api/files/lib_docparser.js.html | 2 +- output/api/files/lib_docview.js.html | 2 +- output/api/files/lib_files.js.html | 2 +- output/api/files/lib_help.js.html | 2 +- output/api/files/lib_index.js.html | 2 +- output/api/files/lib_options.js.html | 2 +- output/api/files/lib_project.js.html | 2 +- output/api/files/lib_server.js.html | 2 +- output/api/files/lib_utils.js.html | 2 +- output/api/files/lib_yuidoc.js.html | 2 +- output/api/index.html | 2 +- output/api/modules/yuidoc.html | 2 +- output/args/index.html | 2 +- output/index.html | 4 +- 29 files changed, 532 insertions(+), 532 deletions(-) diff --git a/docs/args/partials/help.mustache b/docs/args/partials/help.mustache index 7e696424..dbd36f27 100644 --- a/docs/args/partials/help.mustache +++ b/docs/args/partials/help.mustache @@ -1,7 +1,7 @@ YUI Doc generates API documentation from a modified JavaDoc syntax. -Current version (0.8.0) +Current version (0.8.1) Usage: yuidoc diff --git a/output/api/classes/CLI.html b/output/api/classes/CLI.html index d85cb22a..876aa816 100644 --- a/output/api/classes/CLI.html +++ b/output/api/classes/CLI.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/classes/DocBuilder.html b/output/api/classes/DocBuilder.html index 68b85311..59228b51 100644 --- a/output/api/classes/DocBuilder.html +++ b/output/api/classes/DocBuilder.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
@@ -2358,83 +2358,83 @@

Parameters:

Properties

-
-

_mergeCounter

- Number - - - private - - - -
-

- Defined in - lib/builder.js:1012 -

- - -
- -
-

Counter for stepping into merges

- -
- - - -
-
-

_meta

- Object - - - private - - - -
-

- Defined in - lib/builder.js:403 -

- - -
- -
-

Holder for project meta data

- -
- - - -
-
-

files

- Number - - - - - -
-

- Defined in - lib/builder.js:397 -

- - -
- -
-

File counter

- -
- - - -
+
+

_mergeCounter

+ Number + + + private + + + +
+

+ Defined in + lib/builder.js:1012 +

+ + +
+ +
+

Counter for stepping into merges

+ +
+ + + +
+
+

_meta

+ Object + + + private + + + +
+

+ Defined in + lib/builder.js:403 +

+ + +
+ +
+

Holder for project meta data

+ +
+ + + +
+
+

files

+ Number + + + + + +
+

+ Defined in + lib/builder.js:397 +

+ + +
+ +
+

File counter

+ +
+ + + +
diff --git a/output/api/classes/DocParser.html b/output/api/classes/DocParser.html index 037a9640..6338716a 100644 --- a/output/api/classes/DocParser.html +++ b/output/api/classes/DocParser.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
@@ -6686,173 +6686,173 @@

Parameters:

Properties

-
-

_allowAdHocAttrs

- Boolean - - - protected - - - -
-

Inherited from - BaseCore: - base/js/BaseCore.js:155 -

- - -
- -
- This property controls whether or not instances of this class should - allow users to add ad-hoc attributes through the constructor configuration - hash. - - AdHoc attributes are attributes which are not defined by the class, and are - not handled by the MyClass._NON_ATTRS_CFG -
- -

Default: undefined (false)

- - -
-
-

CORRECTIONS

- Object - - - - final - - -
-

- Defined in - lib/docparser.js:190 -

- - -
- -
-

Common errors will get scrubbed instead of being ignored.

- -
- - - -
-
-

DIGESTERS

- Object - - - - final - - -
-

- Defined in - lib/docparser.js:213 -

- - -
- -
-

A map of the default tag processors, keyed by the - tag name. Multiple tags can use the same digester - by supplying the string name that points to the - implementation rather than a function.

- -
- - - -
-
-

IGNORE_TAGLIST

- Array - - - - final - - -
-

- Defined in - lib/docparser.js:178 -

- - -
- -
-

A list of ignored tags. These tags should be ignored because there is - likely to be used for purposes other than JSDoc tags in JavaScript comments.

- -
- - - -
-
-

name

- String - - deprecated - - - - -
-

Inherited from - BaseCore: - base/js/BaseCore.js:297 -

- -

Deprecated: Use this.constructor.NAME

- -
- -
- The string used to identify the class of this object. -
- - - -
-
-

TAGLIST

- Array - - - - final - - -
-

- Defined in - lib/docparser.js:96 -

- - -
- -
-

A list of known tags. This populates a member variable - during initialization, and will be updated if additional - digesters are added.

- -
- - - -
+
+

_allowAdHocAttrs

+ Boolean + + + protected + + + +
+

Inherited from + BaseCore: + base/js/BaseCore.js:155 +

+ + +
+ +
+ This property controls whether or not instances of this class should +allow users to add ad-hoc attributes through the constructor configuration +hash. + +AdHoc attributes are attributes which are not defined by the class, and are +not handled by the MyClass._NON_ATTRS_CFG +
+ +

Default: undefined (false)

+ + +
+
+

CORRECTIONS

+ Object + + + + final + + +
+

+ Defined in + lib/docparser.js:190 +

+ + +
+ +
+

Common errors will get scrubbed instead of being ignored.

+ +
+ + + +
+
+

DIGESTERS

+ Object + + + + final + + +
+

+ Defined in + lib/docparser.js:213 +

+ + +
+ +
+

A map of the default tag processors, keyed by the +tag name. Multiple tags can use the same digester +by supplying the string name that points to the +implementation rather than a function.

+ +
+ + + +
+
+

IGNORE_TAGLIST

+ Array + + + + final + + +
+

+ Defined in + lib/docparser.js:178 +

+ + +
+ +
+

A list of ignored tags. These tags should be ignored because there is +likely to be used for purposes other than JSDoc tags in JavaScript comments.

+ +
+ + + +
+
+

name

+ String + + deprecated + + + + +
+

Inherited from + BaseCore: + base/js/BaseCore.js:297 +

+ +

Deprecated: Use this.constructor.NAME

+ +
+ +
+ The string used to identify the class of this object. +
+ + + +
+
+

TAGLIST

+ Array + + + + final + + +
+

+ Defined in + lib/docparser.js:96 +

+ + +
+ +
+

A list of known tags. This populates a member variable +during initialization, and will be updated if additional +digesters are added.

+ +
+ + + +
diff --git a/output/api/classes/DocView.html b/output/api/classes/DocView.html index 386f2dcf..039a0bb9 100644 --- a/output/api/classes/DocView.html +++ b/output/api/classes/DocView.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/classes/Files.html b/output/api/classes/Files.html index 27616c64..6bccbbbe 100644 --- a/output/api/classes/Files.html +++ b/output/api/classes/Files.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/classes/Help.html b/output/api/classes/Help.html index 8f495e9c..79200ba8 100644 --- a/output/api/classes/Help.html +++ b/output/api/classes/Help.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
@@ -228,32 +228,32 @@

showHelp

Properties

-
-

help

- Array - - - private - - - -
-

- Defined in - lib/help.js:16 -

- - -
- -
-

The help text to display

- -
- - - -
+
+

help

+ Array + + + private + + + +
+

+ Defined in + lib/help.js:16 +

+ + +
+ +
+

The help text to display

+ +
+ + + +
diff --git a/output/api/classes/Main.html b/output/api/classes/Main.html index 6f0237a8..7fcfbfc6 100644 --- a/output/api/classes/Main.html +++ b/output/api/classes/Main.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/classes/Options.html b/output/api/classes/Options.html index f88f1573..528fd0ba 100644 --- a/output/api/classes/Options.html +++ b/output/api/classes/Options.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/classes/Server.html b/output/api/classes/Server.html index cf8dfa91..8ab29df2 100644 --- a/output/api/classes/Server.html +++ b/output/api/classes/Server.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
@@ -648,32 +648,32 @@

Parameters:

Properties

-
-

_externalData

- Object - - - private - - - -
-

- Defined in - lib/server.js:19 -

- - -
- -
-

Cache for external mixed in data.

- -
- - - -
+
+

_externalData

+ Object + + + private + + + +
+

+ Defined in + lib/server.js:19 +

+ + +
+ +
+

Cache for external mixed in data.

+ +
+ + + +
diff --git a/output/api/classes/Utils.html b/output/api/classes/Utils.html index 1dede6a1..7f5b2c06 100644 --- a/output/api/classes/Utils.html +++ b/output/api/classes/Utils.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/classes/YUIDoc.html b/output/api/classes/YUIDoc.html index 0eca8bc1..b9cd4695 100644 --- a/output/api/classes/YUIDoc.html +++ b/output/api/classes/YUIDoc.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
@@ -645,212 +645,212 @@

Returns:

Properties

-
-

dirmap

- Object - - - private - - - -
-

- Defined in - lib/yuidoc.js:89 -

- - -
- -
-

Holder for the list of directories we are processing.

- -
- - - -
-
-

endtime

- Timestamp - - - - - -
-

- Defined in - lib/yuidoc.js:406 -

- - -
- -
-

Timestamp holder so we know when YUIDoc has finished the parse process.

- -
- - - -
-
-

filecount

- Boolean - - - private - - - -
-

- Defined in - lib/yuidoc.js:68 -

- - -
- -
-

Holds the number of files that we are processing.

- -
- - - -
-
-

filemap

- Object - - - private - - - -
-

- Defined in - lib/yuidoc.js:82 -

- - -
- -
-

Holder for the list of files we are processing.

- -
- - - -
-
-

OPTIONS

- Object - - - - final - - -
-

- Defined in - lib/yuidoc.js:31 -

- - -
- -
-

The default list of configuration options

- -
- - - -
-
-

options

- Object - - - private - - - -
-

- Defined in - lib/yuidoc.js:97 -

- - -
- -
-

Internal holder for configuration options.

- -
- - - -
-
-

selleck

- Object - - - private - - - -
-

- Defined in - lib/yuidoc.js:75 -

- - -
- -
-

Hash map of dirnames to selleck config options.

- -
- - - -
-
-

starttime

- Timestamp - - - - - -
-

- Defined in - lib/yuidoc.js:384 -

- - -
- -
-

Timestamp holder so we know when YUIDoc started the parse process.

- -
- - - -
+
+

dirmap

+ Object + + + private + + + +
+

+ Defined in + lib/yuidoc.js:89 +

+ + +
+ +
+

Holder for the list of directories we are processing.

+ +
+ + + +
+
+

endtime

+ Timestamp + + + + + +
+

+ Defined in + lib/yuidoc.js:406 +

+ + +
+ +
+

Timestamp holder so we know when YUIDoc has finished the parse process.

+ +
+ + + +
+
+

filecount

+ Boolean + + + private + + + +
+

+ Defined in + lib/yuidoc.js:68 +

+ + +
+ +
+

Holds the number of files that we are processing.

+ +
+ + + +
+
+

filemap

+ Object + + + private + + + +
+

+ Defined in + lib/yuidoc.js:82 +

+ + +
+ +
+

Holder for the list of files we are processing.

+ +
+ + + +
+
+

OPTIONS

+ Object + + + + final + + +
+

+ Defined in + lib/yuidoc.js:31 +

+ + +
+ +
+

The default list of configuration options

+ +
+ + + +
+
+

options

+ Object + + + private + + + +
+

+ Defined in + lib/yuidoc.js:97 +

+ + +
+ +
+

Internal holder for configuration options.

+ +
+ + + +
+
+

selleck

+ Object + + + private + + + +
+

+ Defined in + lib/yuidoc.js:75 +

+ + +
+ +
+

Hash map of dirnames to selleck config options.

+ +
+ + + +
+
+

starttime

+ Timestamp + + + + + +
+

+ Defined in + lib/yuidoc.js:384 +

+ + +
+ +
+

Timestamp holder so we know when YUIDoc started the parse process.

+ +
+ + + +
diff --git a/output/api/data.json b/output/api/data.json index 48615d43..ac9cadcd 100644 --- a/output/api/data.json +++ b/output/api/data.json @@ -2,7 +2,7 @@ "project": { "name": "yuidoc-root", "description": "YUIDoc, YUI's JavaScript Documentation engine.", - "version": "0.8.0" + "version": "0.8.1" }, "files": { "lib/builder.js": { diff --git a/output/api/files/lib_builder.js.html b/output/api/files/lib_builder.js.html index f5ae8b19..69f2ebc9 100644 --- a/output/api/files/lib_builder.js.html +++ b/output/api/files/lib_builder.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_cli.js.html b/output/api/files/lib_cli.js.html index caa4a5ca..6eec3c9b 100644 --- a/output/api/files/lib_cli.js.html +++ b/output/api/files/lib_cli.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_docparser.js.html b/output/api/files/lib_docparser.js.html index f294dbd3..ecca42e3 100644 --- a/output/api/files/lib_docparser.js.html +++ b/output/api/files/lib_docparser.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_docview.js.html b/output/api/files/lib_docview.js.html index 3bc7c5fb..c59d3367 100644 --- a/output/api/files/lib_docview.js.html +++ b/output/api/files/lib_docview.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_files.js.html b/output/api/files/lib_files.js.html index c2363353..73f29c55 100644 --- a/output/api/files/lib_files.js.html +++ b/output/api/files/lib_files.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_help.js.html b/output/api/files/lib_help.js.html index a8f410a9..2ee81219 100644 --- a/output/api/files/lib_help.js.html +++ b/output/api/files/lib_help.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_index.js.html b/output/api/files/lib_index.js.html index 0c54f907..a7b67b9a 100644 --- a/output/api/files/lib_index.js.html +++ b/output/api/files/lib_index.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_options.js.html b/output/api/files/lib_options.js.html index 2553f693..922c36ee 100644 --- a/output/api/files/lib_options.js.html +++ b/output/api/files/lib_options.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_project.js.html b/output/api/files/lib_project.js.html index 44064c8b..ec8e2f6a 100644 --- a/output/api/files/lib_project.js.html +++ b/output/api/files/lib_project.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_server.js.html b/output/api/files/lib_server.js.html index caf96eec..23e186ba 100644 --- a/output/api/files/lib_server.js.html +++ b/output/api/files/lib_server.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_utils.js.html b/output/api/files/lib_utils.js.html index 31a89acb..e74f406a 100644 --- a/output/api/files/lib_utils.js.html +++ b/output/api/files/lib_utils.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/files/lib_yuidoc.js.html b/output/api/files/lib_yuidoc.js.html index d0e2f3b7..df6fe9a7 100644 --- a/output/api/files/lib_yuidoc.js.html +++ b/output/api/files/lib_yuidoc.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/index.html b/output/api/index.html index ec82223c..158939ac 100644 --- a/output/api/index.html +++ b/output/api/index.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/api/modules/yuidoc.html b/output/api/modules/yuidoc.html index bb24871b..3228c5ea 100644 --- a/output/api/modules/yuidoc.html +++ b/output/api/modules/yuidoc.html @@ -17,7 +17,7 @@

- API Docs for: 0.8.0 + API Docs for: 0.8.1
diff --git a/output/args/index.html b/output/args/index.html index 3e561ea4..ae55758d 100644 --- a/output/args/index.html +++ b/output/args/index.html @@ -45,7 +45,7 @@

Running YUIDoc on the Command Line

YUI Doc generates API documentation from a modified JavaDoc syntax.
 
-Current version (0.8.0)
+Current version (0.8.1)
 
 Usage: yuidoc <options> <input path>
 
diff --git a/output/index.html b/output/index.html
index ea681a84..e3630883 100644
--- a/output/index.html
+++ b/output/index.html
@@ -24,7 +24,7 @@ 

         

             

-                
Welcome to YUIDoc 0.8.0!

+                
Welcome to YUIDoc 0.8.1!

 
 

     
YUIDoc is a Node.js application that
@@ -146,7 +146,7 @@ 
Table of Contents