From 0de8440daac92f7a3c71e5fb270366986151908e Mon Sep 17 00:00:00 2001 From: Ryuichi Okumura Date: Tue, 18 Nov 2014 21:20:08 +0900 Subject: [PATCH] Build docs --- output/api/classes/CLI.html | 2 +- output/api/classes/DocBuilder.html | 58 ++-- output/api/classes/DocParser.html | 408 ++++++++++++++++++------- output/api/classes/DocView.html | 2 +- output/api/classes/Files.html | 8 +- output/api/classes/Help.html | 6 +- output/api/classes/Main.html | 6 +- output/api/classes/Options.html | 2 +- output/api/classes/Server.html | 2 +- output/api/classes/Utils.html | 2 +- output/api/classes/YUIDoc.html | 6 +- output/api/data.json | 98 +++--- output/api/files/lib_builder.js.html | 24 +- output/api/files/lib_cli.js.html | 2 +- output/api/files/lib_docparser.js.html | 16 +- output/api/files/lib_docview.js.html | 2 +- output/api/files/lib_files.js.html | 2 +- output/api/files/lib_help.js.html | 3 +- output/api/files/lib_index.js.html | 2 +- output/api/files/lib_options.js.html | 5 +- output/api/files/lib_server.js.html | 2 +- output/api/files/lib_utils.js.html | 2 +- output/api/files/lib_yuidoc.js.html | 4 +- output/api/index.html | 2 +- output/api/modules/yuidoc.html | 6 +- output/args/index.html | 25 +- output/index.html | 4 +- output/syntax/index.html | 16 +- 28 files changed, 481 insertions(+), 236 deletions(-) diff --git a/output/api/classes/CLI.html b/output/api/classes/CLI.html index c27699fa..c1590890 100644 --- a/output/api/classes/CLI.html +++ b/output/api/classes/CLI.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
diff --git a/output/api/classes/DocBuilder.html b/output/api/classes/DocBuilder.html index 3eb8b421..7fdd9fbe 100644 --- a/output/api/classes/DocBuilder.html +++ b/output/api/classes/DocBuilder.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
@@ -565,7 +565,7 @@

_inlineCode

- lib/builder.js:770 + lib/builder.js:778

@@ -733,7 +733,7 @@

_parseCode

- lib/builder.js:757 + lib/builder.js:765

@@ -977,7 +977,7 @@

addFoundAt

- lib/builder.js:622 + lib/builder.js:630

@@ -1084,7 +1084,7 @@

augmentData

- lib/builder.js:638 + lib/builder.js:646

@@ -1188,7 +1188,7 @@

compile

- lib/builder.js:1605 + lib/builder.js:1615

@@ -1281,7 +1281,7 @@

filterFileName

- lib/builder.js:1592 + lib/builder.js:1602

@@ -1380,7 +1380,7 @@

getProjectMeta

- lib/builder.js:452 + lib/builder.js:460

@@ -1469,7 +1469,7 @@

hasProperty

- lib/builder.js:1019 + lib/builder.js:1027

@@ -1586,7 +1586,7 @@

makeDirs

- lib/builder.js:704 + lib/builder.js:712

@@ -1796,7 +1796,7 @@

mergeExtends

- lib/builder.js:1043 + lib/builder.js:1051

@@ -2018,7 +2018,7 @@

nameSort

- lib/builder.js:1422 + lib/builder.js:1432

@@ -2250,7 +2250,7 @@

populateClasses

- lib/builder.js:495 + lib/builder.js:503

@@ -2357,7 +2357,7 @@

populateFiles

- lib/builder.js:565 + lib/builder.js:573

@@ -2464,7 +2464,7 @@

populateModules

- lib/builder.js:519 + lib/builder.js:527

@@ -2591,7 +2591,7 @@

render

- lib/builder.js:789 + lib/builder.js:797

@@ -2779,7 +2779,7 @@

renderAPIMeta

- lib/builder.js:1560 + lib/builder.js:1570

@@ -2874,7 +2874,7 @@

renderClass

- lib/builder.js:1095 + lib/builder.js:1103

@@ -3003,7 +3003,7 @@

renderFile

- lib/builder.js:1493 + lib/builder.js:1503

@@ -3132,7 +3132,7 @@

renderIndex

- lib/builder.js:845 + lib/builder.js:853

@@ -3261,7 +3261,7 @@

renderModule

- lib/builder.js:894 + lib/builder.js:902

@@ -3386,7 +3386,7 @@

writeAPIMeta

- lib/builder.js:1547 + lib/builder.js:1557

@@ -3475,7 +3475,7 @@

writeClasses

- lib/builder.js:1381 + lib/builder.js:1391

@@ -3564,7 +3564,7 @@

writeFiles

- lib/builder.js:1445 + lib/builder.js:1455

@@ -3653,7 +3653,7 @@

writeIndex

- lib/builder.js:870 + lib/builder.js:878

@@ -3742,7 +3742,7 @@

writeModules

- lib/builder.js:978 + lib/builder.js:986

@@ -3822,7 +3822,7 @@

_mergeCounter

- lib/builder.js:1036 + lib/builder.js:1044

@@ -3869,7 +3869,7 @@

_meta

- lib/builder.js:445 + lib/builder.js:453

@@ -3914,7 +3914,7 @@

files

- lib/builder.js:439 + lib/builder.js:447

diff --git a/output/api/classes/DocParser.html b/output/api/classes/DocParser.html index a6dd5b6e..a7b2b978 100644 --- a/output/api/classes/DocParser.html +++ b/output/api/classes/DocParser.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
@@ -116,7 +116,7 @@

DocParser Class

- Defined in: lib/docparser.js:727 + Defined in: lib/docparser.js:735
@@ -183,7 +183,7 @@

DocParser

- lib/docparser.js:727 + lib/docparser.js:735

@@ -1316,8 +1316,8 @@

_addOutOfOrder

bar: { value: ... } -}); - +}); +
@@ -2557,7 +2557,7 @@

_getAttrCfg

- attribute/js/AttributeExtras.js:114 + attribute/js/AttributeExtras.js:125

@@ -3074,7 +3074,7 @@

_getFullType

- event-custom/js/event-target.js:586 + event-custom/js/event-target.js:564

@@ -4263,7 +4263,7 @@

_monitor

- event-custom/js/event-target.js:658 + event-custom/js/event-target.js:636

@@ -4776,7 +4776,7 @@

_publish

- event-custom/js/event-target.js:610 + event-custom/js/event-target.js:588

@@ -4920,7 +4920,7 @@

_resolveFor

- lib/docparser.js:1011 + lib/docparser.js:1019

@@ -6319,7 +6319,7 @@

after

- event-custom/js/event-target.js:834 + event-custom/js/event-target.js:812

@@ -6572,7 +6572,7 @@

before

- event-custom/js/event-target.js:871 + event-custom/js/event-target.js:849

@@ -6848,7 +6848,7 @@

detach

- event-custom/js/event-target.js:346 + event-custom/js/event-target.js:356

@@ -6988,7 +6988,7 @@

detachAll

- event-custom/js/event-target.js:469 + event-custom/js/event-target.js:479

@@ -7089,7 +7089,7 @@

extract

- lib/docparser.js:1182 + lib/docparser.js:1190

@@ -7221,7 +7221,7 @@

fire

- event-custom/js/event-target.js:695 + event-custom/js/event-target.js:673

@@ -7577,7 +7577,7 @@

getEvent

- event-custom/js/event-target.js:815 + event-custom/js/event-target.js:793

@@ -7777,7 +7777,7 @@

handlecomment

- lib/docparser.js:1106 + lib/docparser.js:1114

@@ -8247,8 +8247,20 @@

modifyAttr

The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified -after a value has already been set on the attribute: readOnly, writeOnce, -broadcast and getter. +after a value has already been set on the attribute: +

+
+
readOnly;
+
writeOnce;
+
broadcast; and
+
getter.
+
+

+Note: New attributes cannot be added using this interface. New attributes must be +added using addAttr, or an +appropriate manner for a class which utilises Attributes (e.g. the +ATTRS property in +Base).

@@ -8374,7 +8386,8 @@

on

Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.

-

Callback functions for events published with emitFacade = true will +

 this.on("change", this._onChange, this);
+

Callback functions for events published with emitFacade = true will receive an EventFacade as the first argument (typically named "e"). These callbacks can then call e.preventDefault() to disable the behavior published to that event's defaultFn. See the EventFacade @@ -8382,10 +8395,15 @@

on

non-emitFacade events will receive the arguments passed to fire() after the event name.

To subscribe to multiple events at once, pass an object as the first -argument, where the key:value pairs correspond to the eventName:callback, -or pass an array of event names as the first argument to subscribe to -all listed events with the same callback.

-

Returning false from a callback is supported as an alternative to +argument, where the key:value pairs correspond to the eventName:callback.

+
 this.on({
+     "attrChange" : this._onAttrChange,
+     "change"     : this._onChange
+ });
+

You can also pass an array of event names as the first argument to +subscribe to all listed events with the same callback.

+
 this.on([ "change", "attrChange" ], this._onChange);
+

Returning false from a callback is supported as an alternative to calling e.preventDefault(); e.stopPropagation();. However, it is recommended to use the event methods whenever possible.

@@ -8890,7 +8908,7 @@

parse

- lib/docparser.js:1424 + lib/docparser.js:1432

@@ -9090,11 +9108,13 @@

Returns:

Array: -

an array containing: - the detach category, if supplied, - the prefixed event type, - whether or not this is an after listener, - the supplied event type

+

an array containing:

+
@@ -9147,7 +9167,7 @@

processblock

- lib/docparser.js:1237 + lib/docparser.js:1245

@@ -9243,7 +9263,7 @@

publish

- event-custom/js/event-target.js:493 + event-custom/js/event-target.js:503

@@ -9292,61 +9312,245 @@

Parameters:

optional config params. Valid properties are:

- +
+ + @@ -9412,7 +9616,7 @@

removeAttr

- attribute/js/AttributeExtras.js:79 + attribute/js/AttributeExtras.js:90

@@ -9592,7 +9796,7 @@

reset

- attribute/js/AttributeExtras.js:89 + attribute/js/AttributeExtras.js:100

@@ -10083,7 +10287,7 @@

subscribe

- event-custom/js/event-target.js:336 + event-custom/js/event-target.js:346

@@ -10225,7 +10429,7 @@

transform

- lib/docparser.js:1310 + lib/docparser.js:1318

@@ -10336,7 +10540,7 @@

unindent

- lib/docparser.js:1085 + lib/docparser.js:1093

@@ -10431,7 +10635,7 @@

unsubscribe

- event-custom/js/event-target.js:459 + event-custom/js/event-target.js:469

@@ -10497,7 +10701,7 @@

unsubscribeAll

- event-custom/js/event-target.js:480 + event-custom/js/event-target.js:490

@@ -10836,7 +11040,7 @@

currentclass

- lib/docparser.js:971 + lib/docparser.js:979

@@ -10939,7 +11143,7 @@

currentfile

- lib/docparser.js:815 + lib/docparser.js:823

@@ -11042,7 +11246,7 @@

currentmodule

- lib/docparser.js:872 + lib/docparser.js:880

@@ -11145,7 +11349,7 @@

currentsubmodule

- lib/docparser.js:931 + lib/docparser.js:939

@@ -11353,7 +11557,7 @@

digesters

- lib/docparser.js:755 + lib/docparser.js:763

@@ -11466,7 +11670,7 @@

dirmap

- lib/docparser.js:805 + lib/docparser.js:813

@@ -11571,7 +11775,7 @@

emitters

- lib/docparser.js:777 + lib/docparser.js:785

@@ -11675,7 +11879,7 @@

filemap

- lib/docparser.js:797 + lib/docparser.js:805

@@ -11883,7 +12087,7 @@

mainmodule

- lib/docparser.js:836 + lib/docparser.js:844

@@ -11986,7 +12190,7 @@

syntaxtype

- lib/docparser.js:788 + lib/docparser.js:796

diff --git a/output/api/classes/DocView.html b/output/api/classes/DocView.html index 5ddf6dee..93a7ac6c 100644 --- a/output/api/classes/DocView.html +++ b/output/api/classes/DocView.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
diff --git a/output/api/classes/Files.html b/output/api/classes/Files.html index 59cc1e70..c87c9b21 100644 --- a/output/api/classes/Files.html +++ b/output/api/classes/Files.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
@@ -820,8 +820,10 @@

copyPath

the full path to the new file (including the new filename). Otherwise, it will be interpreted as an attempt to copy the source file over the dest directory instead of into it.

-

Known issues: -- Doesn't preserve ownership or permissions on copied files/directories.

+

Known issues:

+
diff --git a/output/api/classes/Help.html b/output/api/classes/Help.html index 19e6b2d2..daba6186 100644 --- a/output/api/classes/Help.html +++ b/output/api/classes/Help.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
@@ -239,7 +239,7 @@

renderHelp

- lib/help.js:60 + lib/help.js:61

@@ -308,7 +308,7 @@

showHelp

- lib/help.js:70 + lib/help.js:71

diff --git a/output/api/classes/Main.html b/output/api/classes/Main.html index 56223f41..1b5cc05c 100644 --- a/output/api/classes/Main.html +++ b/output/api/classes/Main.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
@@ -136,8 +136,8 @@

Main Class

}; var Y = require('yuidocjs'); -var json = (new Y.YUIDoc(options)).run(); - +var json = (new Y.YUIDoc(options)).run(); +
diff --git a/output/api/classes/Options.html b/output/api/classes/Options.html index bdd6d791..8d7d5edc 100644 --- a/output/api/classes/Options.html +++ b/output/api/classes/Options.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
diff --git a/output/api/classes/Server.html b/output/api/classes/Server.html index e1f2ed32..af450ce5 100644 --- a/output/api/classes/Server.html +++ b/output/api/classes/Server.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
diff --git a/output/api/classes/Utils.html b/output/api/classes/Utils.html index 1cf31df1..68e7a809 100644 --- a/output/api/classes/Utils.html +++ b/output/api/classes/Utils.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
diff --git a/output/api/classes/YUIDoc.html b/output/api/classes/YUIDoc.html index f567fdc3..ee2c3710 100644 --- a/output/api/classes/YUIDoc.html +++ b/output/api/classes/YUIDoc.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.50 + API Docs for: 0.4.0
@@ -135,8 +135,8 @@

YUIDoc Class

}; var Y = require('yuidoc'); - var json = (new Y.YUIDoc(options)).run(); - + var json = (new Y.YUIDoc(options)).run(); +
diff --git a/output/api/data.json b/output/api/data.json index aa97a6dd..2de8fa14 100644 --- a/output/api/data.json +++ b/output/api/data.json @@ -3,7 +3,7 @@ "name": "yuidoc-root", "logo": "http://yuilibrary.com/img/yui-logo.png", "description": "YUIDoc, YUI's JavaScript Documentation engine.", - "version": "0.3.50" + "version": "0.4.0" }, "files": { "lib/builder.js": { @@ -180,7 +180,7 @@ "module": "yuidoc", "namespace": "", "file": "lib/docparser.js", - "line": 727, + "line": 735, "description": "The doc parser accepts a **map** of files to file content.\nOnce `parse()` is called, various properties will be populated\nwith the parsers data (aggregated in the `'data'` property).", "extends": "Base", "is_constructor": 1, @@ -462,7 +462,7 @@ }, { "file": "lib/builder.js", - "line": 439, + "line": 447, "description": "File counter", "itemtype": "property", "name": "files", @@ -472,7 +472,7 @@ }, { "file": "lib/builder.js", - "line": 445, + "line": 453, "description": "Holder for project meta data", "itemtype": "property", "name": "_meta", @@ -484,7 +484,7 @@ }, { "file": "lib/builder.js", - "line": 452, + "line": 460, "description": "Prep the meta data to be fed to Selleck", "itemtype": "method", "name": "getProjectMeta", @@ -497,7 +497,7 @@ }, { "file": "lib/builder.js", - "line": 495, + "line": 503, "description": "Populate the meta data for classes", "itemtype": "method", "name": "populateClasses", @@ -517,7 +517,7 @@ }, { "file": "lib/builder.js", - "line": 519, + "line": 527, "description": "Populate the meta data for modules", "itemtype": "method", "name": "populateModules", @@ -537,7 +537,7 @@ }, { "file": "lib/builder.js", - "line": 565, + "line": 573, "description": "Populate the meta data for files", "itemtype": "method", "name": "populateFiles", @@ -557,7 +557,7 @@ }, { "file": "lib/builder.js", - "line": 622, + "line": 630, "description": "Parses file and line number from an item object and build's an HREF", "itemtype": "method", "name": "addFoundAt", @@ -577,7 +577,7 @@ }, { "file": "lib/builder.js", - "line": 638, + "line": 646, "description": "Augments the **DocParser** meta data to provide default values for certain keys as well as parses all descriptions\nwith the `Markdown Parser`", "itemtype": "method", "name": "augmentData", @@ -597,7 +597,7 @@ }, { "file": "lib/builder.js", - "line": 704, + "line": 712, "description": "Makes the default directories needed", "itemtype": "method", "name": "makeDirs", @@ -613,7 +613,7 @@ }, { "file": "lib/builder.js", - "line": 757, + "line": 765, "description": "Parses `
` tags and adds the __prettyprint__ `className` to them",
             "itemtype": "method",
             "name": "_parseCode",
@@ -635,7 +635,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 770,
+            "line": 778,
             "description": "Ported from [Selleck](https://github.com/rgrove/selleck), this handles ```'s in fields\n       that are not parsed by the **Markdown** parser.",
             "itemtype": "method",
             "name": "_inlineCode",
@@ -657,7 +657,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 789,
+            "line": 797,
             "description": "Ported from [Selleck](https://github.com/rgrove/selleck)\n       Renders the handlebars templates with the default View class.",
             "itemtype": "method",
             "name": "render",
@@ -709,7 +709,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 845,
+            "line": 853,
             "description": "Render the index file",
             "itemtype": "method",
             "name": "renderIndex",
@@ -737,7 +737,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 870,
+            "line": 878,
             "description": "Generates the index.html file",
             "itemtype": "method",
             "name": "writeIndex",
@@ -753,7 +753,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 894,
+            "line": 902,
             "description": "Render a module",
             "itemtype": "method",
             "name": "renderModule",
@@ -781,7 +781,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 978,
+            "line": 986,
             "description": "Generates the module files under \"out\"/modules/",
             "itemtype": "method",
             "name": "writeModules",
@@ -797,7 +797,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1019,
+            "line": 1027,
             "description": "Checks an array of items (class items) to see if an item is in that list",
             "itemtype": "method",
             "name": "hasProperty",
@@ -821,7 +821,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1036,
+            "line": 1044,
             "description": "Counter for stepping into merges",
             "access": "private",
             "tagname": "",
@@ -833,7 +833,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1043,
+            "line": 1051,
             "description": "Merge superclass data into a child class",
             "itemtype": "method",
             "name": "mergeExtends",
@@ -859,7 +859,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1095,
+            "line": 1103,
             "description": "Render the class file",
             "itemtype": "method",
             "name": "renderClass",
@@ -887,7 +887,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1381,
+            "line": 1391,
             "description": "Generates the class files under \"out\"/classes/",
             "itemtype": "method",
             "name": "writeClasses",
@@ -903,7 +903,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1422,
+            "line": 1432,
             "description": "Sort method of array of objects with a property called __name__",
             "itemtype": "method",
             "name": "nameSort",
@@ -928,7 +928,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1445,
+            "line": 1455,
             "description": "Generates the syntax files under `\"out\"/files/`",
             "itemtype": "method",
             "name": "writeFiles",
@@ -944,7 +944,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1493,
+            "line": 1503,
             "description": "Render the source file",
             "itemtype": "method",
             "name": "renderFile",
@@ -972,7 +972,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1547,
+            "line": 1557,
             "description": "Write the API meta data used for the AutoComplete widget",
             "itemtype": "method",
             "name": "writeAPIMeta",
@@ -989,7 +989,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1560,
+            "line": 1570,
             "description": "Render the API meta and return the Javascript",
             "itemtype": "method",
             "name": "renderAPIMeta",
@@ -1006,7 +1006,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1592,
+            "line": 1602,
             "description": "Normalizes a file path to a writable filename:\n\n   var path = 'lib/file.js';\n   returns 'lib_file.js';",
             "itemtype": "method",
             "name": "filterFileName",
@@ -1026,7 +1026,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1605,
+            "line": 1615,
             "description": "Compiles the templates from the meta-data provided by DocParser",
             "itemtype": "method",
             "name": "compile",
@@ -1141,7 +1141,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 755,
+            "line": 763,
             "description": "Digesters process the tag/text pairs found in a\ncomment block.  They are looked up by tag name.\nThe digester gets the tagname, the value, the\ntarget object to apply values to, and the full\nblock that is being processed.  Digesters can\nbe declared as strings instead of a function --\nin that case, the program will try to look up\nthe key listed and use the function there instead\n(it is an alias).  Digesters can return a host\nobject in the case the tag defines a new key\nblock type (modules/classes/methods/events/properties)",
             "itemtype": "attribute",
             "name": "digesters",
@@ -1150,7 +1150,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 777,
+            "line": 785,
             "description": "Emitters will be schemas for the types of payloads\nthe parser will emit.  Not implemented.",
             "itemtype": "attribute",
             "name": "emitters",
@@ -1159,7 +1159,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 788,
+            "line": 796,
             "description": "Comment syntax type.",
             "itemtype": "attribute",
             "name": "syntaxtype",
@@ -1169,7 +1169,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 797,
+            "line": 805,
             "description": "The map of file names to file content.",
             "itemtype": "attribute",
             "name": "filemap",
@@ -1178,7 +1178,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 805,
+            "line": 813,
             "description": "A map of file names to directory name.  Provided in\ncase this needs to be used to reset the module name\nappropriately -- currently not used",
             "itemtype": "attribute",
             "name": "dirmap",
@@ -1187,7 +1187,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 815,
+            "line": 823,
             "description": "The file currently being parsed",
             "itemtype": "attribute",
             "name": "currentfile",
@@ -1197,7 +1197,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 836,
+            "line": 844,
             "description": "The main documentation block for the module itself.",
             "itemtype": "attribute",
             "name": "mainmodule",
@@ -1207,7 +1207,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 872,
+            "line": 880,
             "description": "The module currently being parsed",
             "itemtype": "attribute",
             "name": "currentmodule",
@@ -1217,7 +1217,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 931,
+            "line": 939,
             "description": "The submodule currently being parsed",
             "itemtype": "attribute",
             "name": "currentsubmodule",
@@ -1227,7 +1227,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 971,
+            "line": 979,
             "description": "The class currently being parsed",
             "itemtype": "attribute",
             "name": "currentclass",
@@ -1237,7 +1237,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1011,
+            "line": 1019,
             "description": "Takes a non-namespaced classname and resolves it to a namespace (to support `@for`)",
             "access": "private",
             "tagname": "",
@@ -1259,7 +1259,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1085,
+            "line": 1093,
             "description": "Normalizes the initial indentation of the given _content_ so that the first line\nis unindented, and all other lines are unindented to the same degree as the\nfirst line. So if the first line has four spaces at the beginning, then all\nlines will be unindented four spaces. Ported from [Selleck](https://github.com/rgrove/selleck)",
             "itemtype": "method",
             "name": "unindent",
@@ -1281,7 +1281,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1106,
+            "line": 1114,
             "description": "Transforms a JavaDoc style comment block (less the start and end of it)\ninto a list of tag/text pairs. The leading space and '*' are removed,\nbut the remaining whitespace is preserved so that the output should be\nfriendly for both markdown and html parsers.",
             "itemtype": "method",
             "name": "handlecomment",
@@ -1307,7 +1307,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1182,
+            "line": 1190,
             "description": "Accepts a map of filenames to file content.  Returns\na map of filenames to an array of API comment block\ntext.  This expects the comment to start with / **\non its own line, and end with * / on its own\nline.  Override this function to provide an\nalternative comment parser.",
             "itemtype": "method",
             "name": "extract",
@@ -1332,7 +1332,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1237,
+            "line": 1245,
             "description": "Processes all the tags in a single comment block",
             "itemtype": "method",
             "name": "processblock",
@@ -1348,7 +1348,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1310,
+            "line": 1318,
             "description": "Transforms a map of filenames to arrays of comment blocks into a\nJSON structure that represents the entire processed API doc info\nand relationships between elements for the entire project.",
             "itemtype": "method",
             "name": "transform",
@@ -1368,7 +1368,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1424,
+            "line": 1432,
             "description": "Extracts and transforms the filemap provided to constructor",
             "itemtype": "method",
             "name": "parse",
@@ -1744,7 +1744,7 @@
         },
         {
             "file": "lib/help.js",
-            "line": 60,
+            "line": 61,
             "description": "Render the help message as a string",
             "itemtype": "method",
             "name": "renderHelp",
@@ -1757,7 +1757,7 @@
         },
         {
             "file": "lib/help.js",
-            "line": 70,
+            "line": 71,
             "description": "Display the help message, write it to the screen and exit",
             "itemtype": "method",
             "name": "showHelp",
diff --git a/output/api/files/lib_builder.js.html b/output/api/files/lib_builder.js.html
index 2f5ca437..52e05ec2 100644
--- a/output/api/files/lib_builder.js.html
+++ b/output/api/files/lib_builder.js.html
@@ -19,7 +19,7 @@ 

             
         
         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

@@ -509,8 +509,14 @@ 
File: lib/builder.js

             var stack = new Y.Parallel();
             info.data.forEach(function (i) {
                 var base;
+                if (typeof i === 'object') {
+                    base = i.base;
+                    i = i.json;
+                }
                 if (i.match(/^https?:\/\//)) {
-                    base = i.replace('data.json', '');
+                    if (!base) {
+                        base = i.replace('data.json', '');
+                    }
                     Y.use('io-base', stack.add(function () {
                         Y.log('Fetching: ' + i, 'info', 'builder');
                         Y.io(i, {
@@ -529,7 +535,9 @@ 
File: lib/builder.js

                         });
                     }));
                 } else {
-                    base = path.dirname(path.resolve(i));
+                    if (!base) {
+                        base = path.dirname(path.resolve(i));
+                    }
                     var data = Y.Files.getJSON(i);
                     data.base = base;
                     //self.options.externalData = Y.mix(self.options.externalData || {}, data);
@@ -1456,10 +1464,12 @@ 
File: lib/builder.js

                     }
                 });
 
-                opts.meta.attrs.sort(self.nameSort);
-                opts.meta.events.sort(self.nameSort);
-                opts.meta.methods.sort(self.nameSort);
-                opts.meta.properties.sort(self.nameSort);
+                if (!self.options.dontsortfields) {
+                    opts.meta.attrs.sort(self.nameSort);
+                    opts.meta.events.sort(self.nameSort);
+                    opts.meta.methods.sort(self.nameSort);
+                    opts.meta.properties.sort(self.nameSort);
+                }
 
                 if (!opts.meta.methods.length) {
                     delete opts.meta.methods;
diff --git a/output/api/files/lib_cli.js.html b/output/api/files/lib_cli.js.html
index b4e0cf10..b873060e 100644
--- a/output/api/files/lib_cli.js.html
+++ b/output/api/files/lib_cli.js.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

diff --git a/output/api/files/lib_docparser.js.html b/output/api/files/lib_docparser.js.html
index ea486a29..b402b833 100644
--- a/output/api/files/lib_docparser.js.html
+++ b/output/api/files/lib_docparser.js.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

@@ -173,8 +173,8 @@ 
File: lib/docparser.js

         CURRENT_CLASS = 'currentclass',
 
         REGEX_TYPE = /(.*?)\{(.*?)\}(.*)/,
-        REGEX_FIRSTWORD = /^\s*?([^\s]+)(.*)/,
-        REGEX_OPTIONAL = /\[(.*?)\]/,
+        REGEX_FIRSTWORD = /^\s*?(\[.+\]\*?|[^\s]+)(.*)/,
+        REGEX_OPTIONAL = /^\[(.*)\]$/,
         REGEX_START_COMMENT = {
             js: /^\s*\/\*\*/,
             coffee: /^\s*###\*/
@@ -322,7 +322,7 @@ 
File: lib/docparser.js

             //   "type": "string",
             //   "optional": true, // [surroundedbybrackets]
             //   "optdefault": "if specified, this is always string to avoid syntax errors @TODO",
-            //   "multiple": true // endswith*
+            //   "multiple": true // endswith* or ...startswith
             // }
             // ],
             // @param {type} name description    -or-
@@ -422,6 +422,14 @@ 
File: lib/docparser.js

                     }
                 }
 
+                // This should run after the check for optional parameters
+                // and before the check for child parameters
+                // because the signature for 0..n params is [...args]
+                if (name.substr(0, 3) === '...') {
+                    multiple = true;
+                    name = name.substr(3);
+                }
+
                 // parse object.prop, indicating a child property for object
                 if (name.indexOf('.') > -1) {
                     match = name.split('.');
diff --git a/output/api/files/lib_docview.js.html b/output/api/files/lib_docview.js.html
index 9596a7e5..5ef54c48 100644
--- a/output/api/files/lib_docview.js.html
+++ b/output/api/files/lib_docview.js.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

diff --git a/output/api/files/lib_files.js.html b/output/api/files/lib_files.js.html
index e3aecf7f..0d159091 100644
--- a/output/api/files/lib_files.js.html
+++ b/output/api/files/lib_files.js.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

diff --git a/output/api/files/lib_help.js.html b/output/api/files/lib_help.js.html
index 3ed9e5b0..d575d9af 100644
--- a/output/api/files/lib_help.js.html
+++ b/output/api/files/lib_help.js.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

@@ -149,6 +149,7 @@ 
File: lib/help.js

         "  -N, --no-color Turn off terminal colors (for automation)",
         "  -C, --no-code Turn off code generation (don't include source files in output)",
         "  -n, --norecurse Do not recurse directories (default is to recurse)",
+        "  --no-sort Do not alphabetical sorting of attributes, events, methods, and properties",
         "  -S, --selleck Look for Selleck component data and attach to API meta data",
         "  -V, --view Dump the Handlebars.js view data instead of writing template files",
         "  -p, --parse-only Only parse the API docs and create the JSON data, do not render templates",
diff --git a/output/api/files/lib_index.js.html b/output/api/files/lib_index.js.html
index 427194e6..4b6c604c 100644
--- a/output/api/files/lib_index.js.html
+++ b/output/api/files/lib_index.js.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

diff --git a/output/api/files/lib_options.js.html b/output/api/files/lib_options.js.html
index dd53ceb1..2c8d9423 100644
--- a/output/api/files/lib_options.js.html
+++ b/output/api/files/lib_options.js.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

@@ -257,6 +257,9 @@ 
File: lib/options.js

                     }
                 }
                 break;
+            case "--no-sort":
+                options.dontsortfields = true;
+                break;
             default:
                 if (!options.paths) {
                     options.paths = [];
diff --git a/output/api/files/lib_server.js.html b/output/api/files/lib_server.js.html
index 7b27a41b..48a07aaa 100644
--- a/output/api/files/lib_server.js.html
+++ b/output/api/files/lib_server.js.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

diff --git a/output/api/files/lib_utils.js.html b/output/api/files/lib_utils.js.html
index 39241ced..2dbacb11 100644
--- a/output/api/files/lib_utils.js.html
+++ b/output/api/files/lib_utils.js.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

diff --git a/output/api/files/lib_yuidoc.js.html b/output/api/files/lib_yuidoc.js.html
index e3bf98b5..19a6b22c 100644
--- a/output/api/files/lib_yuidoc.js.html
+++ b/output/api/files/lib_yuidoc.js.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

@@ -435,7 +435,7 @@ 
File: lib/yuidoc.js

             }
 
             if (self.options.project) {
-                parser.data.project = self.options.project;
+                data.project = self.options.project;
             }
 
             if (self.options.writeJSON) {
diff --git a/output/api/index.html b/output/api/index.html
index 075804d1..bc913c79 100644
--- a/output/api/index.html
+++ b/output/api/index.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

diff --git a/output/api/modules/yuidoc.html b/output/api/modules/yuidoc.html
index 06888134..866d1fa1 100644
--- a/output/api/modules/yuidoc.html
+++ b/output/api/modules/yuidoc.html
@@ -19,7 +19,7 @@ 

             
         

         

-            API Docs for: 0.3.50
+            API Docs for: 0.4.0
         

     
     

@@ -129,8 +129,8 @@ 
yuidoc Module

 };
 
 var Y = require('yuidocjs');
-var json = (new Y.YUIDoc(options)).run();
- +var json = (new Y.YUIDoc(options)).run(); + diff --git a/output/args/index.html b/output/args/index.html index 52be44ce..c838e734 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.3.50)
+Current version (0.4.0)
 
 Usage: yuidoc <options> <input path>
 
@@ -63,6 +63,7 @@ 
Running YUIDoc on the Command Line

   -N, --no-color Turn off terminal colors (for automation)
   -C, --no-code Turn off code generation (don't include source files in output)
   -n, --norecurse Do not recurse directories (default is to recurse)
+  --no-sort Do not alphabetical sorting of attributes, events, methods, and properties
   -S, --selleck Look for Selleck component data and attach to API meta data
   -V, --view Dump the Handlebars.js view data instead of writing template files
   -p, --parse-only Only parse the API docs and create the JSON data, do not render templates
@@ -162,6 +163,28 @@ 
Adding External YUIDoc Data to Your Project

 }
+

+ Also, you are able to give base data within external for external base URLs. +

+ +
{
+  "options": {
+    "external": {
+      "data": [
+        {
+          "base": "http://emberjs.com/api/",
+          "json": "http://builds.emberjs.com/tags/v1.5.1/ember-docs.json"
+        },
+        {
+          "base": "http://emberjs.com/api/",
+          "json": "http://builds.emberjs.com/tags/v1.0.0-beta.6/ember-data-docs.json"
+        }
+      ]
+    }
+  }
+}
+ +

NOTE: YUIDoc currently fetches external data on each run with no caching.

diff --git a/output/index.html b/output/index.html index e106b944..b9d23e8f 100644 --- a/output/index.html +++ b/output/index.html @@ -24,7 +24,7 @@

YUIDoc - Javascript Docume
-

Welcome to YUIDoc 0.3.45!

+

Welcome to YUIDoc 0.4.0!

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

Table of Contents

  • -Welcome to YUIDoc 0.3.45! +Welcome to YUIDoc 0.4.0!
  • Installation and Usage diff --git a/output/syntax/index.html b/output/syntax/index.html index 80f71b92..0317da66 100644 --- a/output/syntax/index.html +++ b/output/syntax/index.html @@ -50,7 +50,7 @@

    Basic Requirements

    A given comment block must contain one (and only one) primary tag such as @class or @method, -and zero or more secondary tags +and zero or more secondary tags such as @param, @type, and @extends. Some secondary tags can be used in any comment block, while others only make sense alongside a particular primary tag.

    @@ -138,7 +138,7 @@

    Primary Tags

    In JavaScript, this is generally an object with a constructor function. The value of @class should be the string that identifies the functional class on its parent object. For example, the @class for Y.DD.Drag would be Drag - (and its @namespace would be DD).

    + (and its @namespace would be DD).

    YUIDoc expects methods, properties, attributes, and events to belong to a class, so in general you must provide at least one class for each module in your source tree. @@ -160,8 +160,6 @@

    Primary Tags

    @uses.

    - - method @@ -196,8 +194,6 @@

    Primary Tags

    @static.

    - - event @@ -465,7 +461,6 @@

    Secondary tags

    - final @@ -669,8 +664,8 @@

    Secondary tags

    • [name] — optional parameter
    • [name=foo] — default value is foo
      • -
    • name* — placeholder for 1..n args
      • -
    • [name]* — placeholder for 0..n args
      • +
    • ...name — placeholder for 1..n args
      • +
    • [...name] — placeholder for 0..n args

    As shown in the example, you can also nest @param tags. @@ -879,7 +874,6 @@

    Secondary tags

    @type.

    - *uses @@ -1268,7 +1262,7 @@

    Cross-referencing Modules and Cla

    -You can also call crossLinkRaw to retun only the HREF portion of the link, so you can link it +You can also call crossLinkRaw to return only the HREF portion of the link, so you can link it yourself.