From 5b21307aa95ab252ed13fd21eff25ccab032be3f Mon Sep 17 00:00:00 2001 From: Ryuichi Okumura Date: Mon, 18 Jan 2016 21:59:30 +0900 Subject: [PATCH] Build documentations --- docs/args/partials/help.mustache | 2 +- output/api/classes/CLI.html | 6 +- output/api/classes/DocBuilder.html | 66 ++++++++++----------- output/api/classes/DocParser.html | 6 +- output/api/classes/DocView.html | 6 +- output/api/classes/Files.html | 6 +- output/api/classes/Help.html | 6 +- output/api/classes/Main.html | 6 +- output/api/classes/Options.html | 6 +- output/api/classes/Server.html | 6 +- output/api/classes/Utils.html | 32 ++++++++--- output/api/classes/YUIDoc.html | 6 +- output/api/data.json | 79 ++++++++++++++------------ output/api/files/lib_builder.js.html | 7 ++- output/api/files/lib_cli.js.html | 6 +- output/api/files/lib_docparser.js.html | 6 +- output/api/files/lib_docview.js.html | 6 +- output/api/files/lib_files.js.html | 6 +- output/api/files/lib_help.js.html | 6 +- output/api/files/lib_index.js.html | 6 +- output/api/files/lib_options.js.html | 6 +- output/api/files/lib_project.js.html | 6 +- output/api/files/lib_server.js.html | 6 +- output/api/files/lib_utils.js.html | 75 ++++++++++++------------ output/api/files/lib_yuidoc.js.html | 6 +- output/api/index.html | 6 +- output/api/modules/yuidoc.html | 6 +- output/args/index.html | 2 +- output/index.html | 4 +- 29 files changed, 208 insertions(+), 185 deletions(-) diff --git a/docs/args/partials/help.mustache b/docs/args/partials/help.mustache index 992addcd..13f14384 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.9.0) +Current version (0.10.0) Usage: yuidoc diff --git a/output/api/classes/CLI.html b/output/api/classes/CLI.html index 7c4da830..a43b2504 100644 --- a/output/api/classes/CLI.html +++ b/output/api/classes/CLI.html @@ -2,7 +2,7 @@ - CLI - yuidoc-root + CLI - YUIDoc @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.9.0 + API Docs for: 0.10.0
diff --git a/output/api/classes/DocBuilder.html b/output/api/classes/DocBuilder.html index 0b4ca753..8a329f5f 100644 --- a/output/api/classes/DocBuilder.html +++ b/output/api/classes/DocBuilder.html @@ -2,7 +2,7 @@ - DocBuilder - yuidoc-root + DocBuilder - YUIDoc @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.9.0 + API Docs for: 0.10.0
@@ -358,7 +358,7 @@

_inlineCode

Defined in - lib/builder.js:767 + lib/builder.js:768

@@ -459,7 +459,7 @@

_parseCode

Defined in - lib/builder.js:754 + lib/builder.js:755

@@ -610,7 +610,7 @@

addFoundAt

Defined in - lib/builder.js:625 + lib/builder.js:626

@@ -676,7 +676,7 @@

augmentData

Defined in - lib/builder.js:641 + lib/builder.js:642

@@ -740,7 +740,7 @@

compile

Defined in - lib/builder.js:1737 + lib/builder.js:1738

@@ -797,7 +797,7 @@

filterFileName

Defined in - lib/builder.js:1724 + lib/builder.js:1725

@@ -859,7 +859,7 @@

getProjectMeta

Defined in - lib/builder.js:433 + lib/builder.js:434

@@ -911,7 +911,7 @@

hasProperty

Defined in - lib/builder.js:1055 + lib/builder.js:1056

@@ -984,7 +984,7 @@

makeDirs

Defined in - lib/builder.js:701 + lib/builder.js:702

@@ -1111,7 +1111,7 @@

mergeExtends

Defined in - lib/builder.js:1079 + lib/builder.js:1080

@@ -1248,7 +1248,7 @@

nameSort

Defined in - lib/builder.js:1545 + lib/builder.js:1546

@@ -1325,7 +1325,7 @@

populateClasses

Defined in - lib/builder.js:476 + lib/builder.js:477

@@ -1391,7 +1391,7 @@

populateElements

Defined in - lib/builder.js:500 + lib/builder.js:501

@@ -1457,7 +1457,7 @@

populateFiles

Defined in - lib/builder.js:568 + lib/builder.js:569

@@ -1523,7 +1523,7 @@

populateModules

Defined in - lib/builder.js:522 + lib/builder.js:523

@@ -1598,7 +1598,7 @@

render

Defined in - lib/builder.js:786 + lib/builder.js:787

@@ -1720,7 +1720,7 @@

renderAPIMeta

Defined in - lib/builder.js:1690 + lib/builder.js:1691

@@ -1786,7 +1786,7 @@

renderClass

Defined in - lib/builder.js:1131 + lib/builder.js:1132

@@ -1862,7 +1862,7 @@

renderElement

Defined in - lib/builder.js:1424 + lib/builder.js:1425

@@ -1938,7 +1938,7 @@

renderFile

Defined in - lib/builder.js:1618 + lib/builder.js:1619

@@ -2014,7 +2014,7 @@

renderIndex

Defined in - lib/builder.js:842 + lib/builder.js:843

@@ -2090,7 +2090,7 @@

renderModule

Defined in - lib/builder.js:904 + lib/builder.js:905

@@ -2167,7 +2167,7 @@

writeAPIMeta

Defined in - lib/builder.js:1677 + lib/builder.js:1678

@@ -2224,7 +2224,7 @@

writeComponents

Defined in - lib/builder.js:1501 + lib/builder.js:1502

@@ -2311,7 +2311,7 @@

writeFiles

Defined in - lib/builder.js:1568 + lib/builder.js:1569

@@ -2387,7 +2387,7 @@

writeIndex

Defined in - lib/builder.js:878 + lib/builder.js:879

@@ -2463,7 +2463,7 @@

writeModules

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

@@ -2535,7 +2535,7 @@

_mergeCounter

Defined in - lib/builder.js:1072 + lib/builder.js:1073

@@ -2561,7 +2561,7 @@

_meta

Defined in - lib/builder.js:426 + lib/builder.js:427

@@ -2586,7 +2586,7 @@

files

Defined in - lib/builder.js:420 + lib/builder.js:421

diff --git a/output/api/classes/DocParser.html b/output/api/classes/DocParser.html index b54d2349..e76e359f 100644 --- a/output/api/classes/DocParser.html +++ b/output/api/classes/DocParser.html @@ -2,7 +2,7 @@ - DocParser - yuidoc-root + DocParser - YUIDoc @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.9.0 + API Docs for: 0.10.0
diff --git a/output/api/classes/DocView.html b/output/api/classes/DocView.html index 71e146c1..fee116f9 100644 --- a/output/api/classes/DocView.html +++ b/output/api/classes/DocView.html @@ -2,7 +2,7 @@ - DocView - yuidoc-root + DocView - YUIDoc @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.9.0 + API Docs for: 0.10.0
diff --git a/output/api/classes/Files.html b/output/api/classes/Files.html index 2289c18d..3b6d24f8 100644 --- a/output/api/classes/Files.html +++ b/output/api/classes/Files.html @@ -2,7 +2,7 @@ - Files - yuidoc-root + Files - YUIDoc @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.9.0 + API Docs for: 0.10.0
diff --git a/output/api/classes/Help.html b/output/api/classes/Help.html index e4661eff..809c3d92 100644 --- a/output/api/classes/Help.html +++ b/output/api/classes/Help.html @@ -2,7 +2,7 @@ - Help - yuidoc-root + Help - YUIDoc @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.9.0 + API Docs for: 0.10.0
diff --git a/output/api/classes/Main.html b/output/api/classes/Main.html index 254d0e9c..181191e0 100644 --- a/output/api/classes/Main.html +++ b/output/api/classes/Main.html @@ -2,7 +2,7 @@ - Main - yuidoc-root + Main - YUIDoc @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.9.0 + API Docs for: 0.10.0
diff --git a/output/api/classes/Options.html b/output/api/classes/Options.html index 7c20fccf..d457638b 100644 --- a/output/api/classes/Options.html +++ b/output/api/classes/Options.html @@ -2,7 +2,7 @@ - Options - yuidoc-root + Options - YUIDoc @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.9.0 + API Docs for: 0.10.0
diff --git a/output/api/classes/Server.html b/output/api/classes/Server.html index ca9e5aa1..b75374a8 100644 --- a/output/api/classes/Server.html +++ b/output/api/classes/Server.html @@ -2,7 +2,7 @@ - Server - yuidoc-root + Server - YUIDoc @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.9.0 + API Docs for: 0.10.0
diff --git a/output/api/classes/Utils.html b/output/api/classes/Utils.html index a29dd410..9aac66d3 100644 --- a/output/api/classes/Utils.html +++ b/output/api/classes/Utils.html @@ -2,7 +2,7 @@ - Utils - yuidoc-root + Utils - YUIDoc @@ -14,10 +14,10 @@
-

+

- API Docs for: 0.9.0 + API Docs for: 0.10.0
@@ -269,7 +269,7 @@

fixType

Defined in - lib/utils.js:456 + lib/utils.js:459

@@ -317,7 +317,10 @@

getDirs

(
  • - dir + baseDir +
  • +
  • + ignore
)
@@ -335,7 +338,7 @@

getDirs

Defined in - lib/utils.js:340 + lib/utils.js:339

@@ -352,7 +355,7 @@

Parameters:

  • - dir + baseDir String @@ -362,6 +365,17 @@

    Parameters:

+
  • + ignore + Array + + +
    +

    An array of paths to ignore

    + +
    + +
  • @@ -897,7 +911,7 @@

    validatePaths

    Defined in - lib/utils.js:366 + lib/utils.js:384

    @@ -966,7 +980,7 @@

    webpath

    Defined in - lib/utils.js:478 + lib/utils.js:481

    diff --git a/output/api/classes/YUIDoc.html b/output/api/classes/YUIDoc.html index 637f97ee..2f5ed824 100644 --- a/output/api/classes/YUIDoc.html +++ b/output/api/classes/YUIDoc.html @@ -2,7 +2,7 @@ - YUIDoc - yuidoc-root + YUIDoc - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/data.json b/output/api/data.json index c758dc38..095bc2ca 100644 --- a/output/api/data.json +++ b/output/api/data.json @@ -1,8 +1,8 @@ { "project": { - "name": "yuidoc-root", + "name": "YUIDoc", "description": "YUIDoc, YUI's JavaScript Documentation engine.", - "version": "0.9.0" + "version": "0.10.0" }, "files": { "lib/builder.js": { @@ -444,7 +444,7 @@ }, { "file": "lib/builder.js", - "line": 420, + "line": 421, "description": "File counter", "itemtype": "property", "name": "files", @@ -454,7 +454,7 @@ }, { "file": "lib/builder.js", - "line": 426, + "line": 427, "description": "Holder for project meta data", "itemtype": "property", "name": "_meta", @@ -466,7 +466,7 @@ }, { "file": "lib/builder.js", - "line": 433, + "line": 434, "description": "Prep the meta data to be fed to Selleck", "itemtype": "method", "name": "getProjectMeta", @@ -479,7 +479,7 @@ }, { "file": "lib/builder.js", - "line": 476, + "line": 477, "description": "Populate the meta data for classes", "itemtype": "method", "name": "populateClasses", @@ -499,7 +499,7 @@ }, { "file": "lib/builder.js", - "line": 500, + "line": 501, "description": "Populate the meta data for elements", "itemtype": "method", "name": "populateElements", @@ -519,7 +519,7 @@ }, { "file": "lib/builder.js", - "line": 522, + "line": 523, "description": "Populate the meta data for modules", "itemtype": "method", "name": "populateModules", @@ -539,7 +539,7 @@ }, { "file": "lib/builder.js", - "line": 568, + "line": 569, "description": "Populate the meta data for files", "itemtype": "method", "name": "populateFiles", @@ -559,7 +559,7 @@ }, { "file": "lib/builder.js", - "line": 625, + "line": 626, "description": "Parses file and line number from an item object and build's an HREF", "itemtype": "method", "name": "addFoundAt", @@ -579,7 +579,7 @@ }, { "file": "lib/builder.js", - "line": 641, + "line": 642, "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", @@ -599,7 +599,7 @@ }, { "file": "lib/builder.js", - "line": 701, + "line": 702, "description": "Makes the default directories needed", "itemtype": "method", "name": "makeDirs", @@ -615,7 +615,7 @@ }, { "file": "lib/builder.js", - "line": 754, + "line": 755, "description": "Parses `
    ` tags and adds the __prettyprint__ `className` to them",
                 "itemtype": "method",
                 "name": "_parseCode",
    @@ -637,7 +637,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 767,
    +            "line": 768,
                 "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",
    @@ -659,7 +659,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 786,
    +            "line": 787,
                 "description": "Ported from [Selleck](https://github.com/rgrove/selleck)\n       Renders the handlebars templates with the default View class.",
                 "itemtype": "method",
                 "name": "render",
    @@ -711,7 +711,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 842,
    +            "line": 843,
                 "description": "Render the index file",
                 "itemtype": "method",
                 "name": "renderIndex",
    @@ -739,7 +739,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 878,
    +            "line": 879,
                 "description": "Generates the index.html file",
                 "itemtype": "method",
                 "name": "writeIndex",
    @@ -767,7 +767,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 904,
    +            "line": 905,
                 "description": "Render a module",
                 "itemtype": "method",
                 "name": "renderModule",
    @@ -795,7 +795,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1012,
    +            "line": 1013,
                 "description": "Generates the module files under \"out\"/modules/",
                 "itemtype": "method",
                 "name": "writeModules",
    @@ -823,7 +823,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1055,
    +            "line": 1056,
                 "description": "Checks an array of items (class items) to see if an item is in that list",
                 "itemtype": "method",
                 "name": "hasProperty",
    @@ -847,7 +847,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1072,
    +            "line": 1073,
                 "description": "Counter for stepping into merges",
                 "access": "private",
                 "tagname": "",
    @@ -859,7 +859,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1079,
    +            "line": 1080,
                 "description": "Merge superclass data into a child class",
                 "itemtype": "method",
                 "name": "mergeExtends",
    @@ -885,7 +885,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1131,
    +            "line": 1132,
                 "description": "Render the class file",
                 "itemtype": "method",
                 "name": "renderClass",
    @@ -913,7 +913,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1424,
    +            "line": 1425,
                 "description": "Render the element file",
                 "itemtype": "method",
                 "name": "renderElement",
    @@ -941,7 +941,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1501,
    +            "line": 1502,
                 "description": "Generates the class or element files under \"out\"/classes/ or \"out\"/elements/",
                 "itemtype": "method",
                 "name": "writeComponents",
    @@ -974,7 +974,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1545,
    +            "line": 1546,
                 "description": "Sort method of array of objects with a property called __name__",
                 "itemtype": "method",
                 "name": "nameSort",
    @@ -999,7 +999,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1568,
    +            "line": 1569,
                 "description": "Generates the syntax files under `\"out\"/files/`",
                 "itemtype": "method",
                 "name": "writeFiles",
    @@ -1027,7 +1027,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1618,
    +            "line": 1619,
                 "description": "Render the source file",
                 "itemtype": "method",
                 "name": "renderFile",
    @@ -1055,7 +1055,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1677,
    +            "line": 1678,
                 "description": "Write the API meta data used for the AutoComplete widget",
                 "itemtype": "method",
                 "name": "writeAPIMeta",
    @@ -1072,7 +1072,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1690,
    +            "line": 1691,
                 "description": "Render the API meta and return the JavaScript",
                 "itemtype": "method",
                 "name": "renderAPIMeta",
    @@ -1096,7 +1096,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1724,
    +            "line": 1725,
                 "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",
    @@ -1116,7 +1116,7 @@
             },
             {
                 "file": "lib/builder.js",
    -            "line": 1737,
    +            "line": 1738,
                 "description": "Compiles the templates from the meta-data provided by DocParser",
                 "itemtype": "method",
                 "name": "compile",
    @@ -2301,15 +2301,20 @@
             },
             {
                 "file": "lib/utils.js",
    -            "line": 340,
    +            "line": 339,
                 "description": "Walks the tree from this dir and returns all the subdirs",
                 "itemtype": "method",
                 "name": "getDirs",
                 "params": [
                     {
    -                    "name": "dir",
    +                    "name": "baseDir",
                         "description": "The dir to begin at",
                         "type": "String"
    +                },
    +                {
    +                    "name": "ignore",
    +                    "description": "An array of paths to ignore",
    +                    "type": "Array"
                     }
                 ],
                 "return": {
    @@ -2321,7 +2326,7 @@
             },
             {
                 "file": "lib/utils.js",
    -            "line": 366,
    +            "line": 384,
                 "description": "Make sure all the paths passed are directories and that they are not in the ignore list.",
                 "itemtype": "method",
                 "name": "validatePaths",
    @@ -2344,7 +2349,7 @@
             },
             {
                 "file": "lib/utils.js",
    -            "line": 456,
    +            "line": 459,
                 "description": "Takes a type string and converts it to a \"First letter upper cased\" type. e.g. `(string -> String, object -> Object)`",
                 "itemtype": "method",
                 "name": "fixType",
    @@ -2364,7 +2369,7 @@
             },
             {
                 "file": "lib/utils.js",
    -            "line": 478,
    +            "line": 481,
                 "description": "Produces a normalized web path by joining all the parts and normalizing the\nfilesystem-like path into web compatible url.\nSupports relative and absolute paths.\nCourtesy of [Mojito's utils](https://github.com/yahoo/mojito/)",
                 "itemtype": "method",
                 "name": "webpath",
    diff --git a/output/api/files/lib_builder.js.html b/output/api/files/lib_builder.js.html
    index 75b8c146..8ca48e04 100644
    --- a/output/api/files/lib_builder.js.html
    +++ b/output/api/files/lib_builder.js.html
    @@ -2,7 +2,7 @@
     
     
         
    -    lib/builder.js - yuidoc-root
    +    lib/builder.js - YUIDoc
         
         
         
    @@ -14,10 +14,10 @@
     
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    @@ -476,6 +476,7 @@

    File: lib/builder.js

    Y.use('io-base', stack.add(function () { Y.log('Fetching: ' + i, 'info', 'builder'); Y.io(i, { + timeout: 10000000, on: { complete: stack.add(function (id, e) { Y.log('Received: ' + i, 'info', 'builder'); diff --git a/output/api/files/lib_cli.js.html b/output/api/files/lib_cli.js.html index 1859f1d5..bc68dec7 100644 --- a/output/api/files/lib_cli.js.html +++ b/output/api/files/lib_cli.js.html @@ -2,7 +2,7 @@ - lib/cli.js - yuidoc-root + lib/cli.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/files/lib_docparser.js.html b/output/api/files/lib_docparser.js.html index f4262f57..87ef5180 100644 --- a/output/api/files/lib_docparser.js.html +++ b/output/api/files/lib_docparser.js.html @@ -2,7 +2,7 @@ - lib/docparser.js - yuidoc-root + lib/docparser.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/files/lib_docview.js.html b/output/api/files/lib_docview.js.html index 92ac4a9b..8eba0517 100644 --- a/output/api/files/lib_docview.js.html +++ b/output/api/files/lib_docview.js.html @@ -2,7 +2,7 @@ - lib/docview.js - yuidoc-root + lib/docview.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/files/lib_files.js.html b/output/api/files/lib_files.js.html index 0a757ba2..8a3537de 100644 --- a/output/api/files/lib_files.js.html +++ b/output/api/files/lib_files.js.html @@ -2,7 +2,7 @@ - lib/files.js - yuidoc-root + lib/files.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/files/lib_help.js.html b/output/api/files/lib_help.js.html index 54aea04d..9ece603f 100644 --- a/output/api/files/lib_help.js.html +++ b/output/api/files/lib_help.js.html @@ -2,7 +2,7 @@ - lib/help.js - yuidoc-root + lib/help.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/files/lib_index.js.html b/output/api/files/lib_index.js.html index 0d11d567..793184c7 100644 --- a/output/api/files/lib_index.js.html +++ b/output/api/files/lib_index.js.html @@ -2,7 +2,7 @@ - lib/index.js - yuidoc-root + lib/index.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/files/lib_options.js.html b/output/api/files/lib_options.js.html index 47ef4aa7..ee88b586 100644 --- a/output/api/files/lib_options.js.html +++ b/output/api/files/lib_options.js.html @@ -2,7 +2,7 @@ - lib/options.js - yuidoc-root + lib/options.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/files/lib_project.js.html b/output/api/files/lib_project.js.html index a0aadea2..c500ce25 100644 --- a/output/api/files/lib_project.js.html +++ b/output/api/files/lib_project.js.html @@ -2,7 +2,7 @@ - lib/project.js - yuidoc-root + lib/project.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/files/lib_server.js.html b/output/api/files/lib_server.js.html index 1a2f66ce..068b4cb1 100644 --- a/output/api/files/lib_server.js.html +++ b/output/api/files/lib_server.js.html @@ -2,7 +2,7 @@ - lib/server.js - yuidoc-root + lib/server.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/files/lib_utils.js.html b/output/api/files/lib_utils.js.html index 2efdce20..cf41dbcf 100644 --- a/output/api/files/lib_utils.js.html +++ b/output/api/files/lib_utils.js.html @@ -2,7 +2,7 @@ - lib/utils.js - yuidoc-root + lib/utils.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    @@ -429,27 +429,45 @@

    File: lib/utils.js

    Y.getProjectData = getProjectData; - /** * Walks the tree from this dir and returns all the subdirs * @method getDirs - * @param {String} dir The dir to begin at + * @param {String} baseDir The dir to begin at + * @param {Array} ignore An array of paths to ignore * @return {Array} The array of directories.. */ - var getDirs = function (dir) { - var dirs = fs.readdirSync(dir), - paths = []; + var getDirs = function (baseDir, ignore) { + var inputPaths = [], + paths = [], + i, d, isIgnored, subpath, + stat, possibleDirs, fullPath; - dirs.forEach(function (d) { - var _dir = path.join(dir, d), - stat = fs.lstatSync(_dir); + var inputPath = ''; + while (inputPath !== undefined) { + fullPath = path.join(baseDir, inputPath); + stat = fs.lstatSync(fullPath); if (stat.isDirectory()) { - if (_dir.indexOf('.') !== 0) { - paths = [].concat(paths, _dir, getDirs(_dir)); + if (fullPath !== baseDir) { + paths.push(fullPath); + } + possibleDirs = fs.readdirSync(fullPath); + for (d=0;d<possibleDirs.length;d++) { + subpath = path.join(inputPath, possibleDirs[d]); + isIgnored = false; + for (i=0;i<ignore.length;i++) { + if (subpath.indexOf(ignore[i]) === 0) { + isIgnored = true; + break; + } + } + if (!isIgnored) { + inputPaths.push(subpath); + } } } - }); + inputPath = inputPaths.pop(); + } return paths; }; @@ -463,6 +481,12 @@

    File: lib/utils.js

    * @param {String} [ignore=false] A string to call `.indexOf` on a path to determine if it should be ignored */ var validatePaths = function (paths, ignore) { + if (!ignore) { + ignore = []; + } else if (!(ignore instanceof Array)) { + ignore = [ignore]; + } + var newpaths = []; //Shortcut the *, . & ./ shortcuts that shall globbing fixes for us if (paths === '*' || paths === '.' || paths === './') { @@ -481,7 +505,7 @@

    File: lib/utils.js

    glob = validatePath.replace(/\//g, '\\\\'); } - var glob_paths = getDirs('.'), + var glob_paths = getDirs('.', ignore), is_globbed = false; glob_paths.forEach(function (dir) { @@ -519,27 +543,6 @@

    File: lib/utils.js

    throw ('Paths should be an array of paths'); } - if (ignore) { - if (!(ignore instanceof Array)) { - ignore = [ignore]; - } - var p = [], - shouldIgnore = false; - - paths.forEach(function (v) { - shouldIgnore = false; - ignore.forEach(function (i) { - if (!shouldIgnore && v.indexOf(i) !== -1) { - shouldIgnore = true; - } - }); - if (!shouldIgnore) { - p.push(v); - } - }); - paths = p; - } - paths = paths.sort(); return paths; }; diff --git a/output/api/files/lib_yuidoc.js.html b/output/api/files/lib_yuidoc.js.html index fea126ce..95d62318 100644 --- a/output/api/files/lib_yuidoc.js.html +++ b/output/api/files/lib_yuidoc.js.html @@ -2,7 +2,7 @@ - lib/yuidoc.js - yuidoc-root + lib/yuidoc.js - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/index.html b/output/api/index.html index 1d978260..2adf0d0d 100644 --- a/output/api/index.html +++ b/output/api/index.html @@ -2,7 +2,7 @@ - yuidoc-root + YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/api/modules/yuidoc.html b/output/api/modules/yuidoc.html index 16945aaa..c16d2e58 100644 --- a/output/api/modules/yuidoc.html +++ b/output/api/modules/yuidoc.html @@ -2,7 +2,7 @@ - yuidoc - yuidoc-root + yuidoc - YUIDoc @@ -14,10 +14,10 @@
    -

    +

    - API Docs for: 0.9.0 + API Docs for: 0.10.0
    diff --git a/output/args/index.html b/output/args/index.html index 656f1c93..f5f02466 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.9.0)
    +Current version (0.10.0)
     
     Usage: yuidoc <options> <input path>
     
    diff --git a/output/index.html b/output/index.html
    index 06f0e76f..d0e13389 100644
    --- a/output/index.html
    +++ b/output/index.html
    @@ -24,7 +24,7 @@ 

    -

    Welcome to YUIDoc 0.9.0!

    +

    Welcome to YUIDoc 0.10.0!

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

    Table of Contents