diff --git a/docs/args/partials/help.mustache b/docs/args/partials/help.mustache index cf17f704..20477ce9 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.4.0) +Current version (0.5.0) Usage: yuidoc diff --git a/output/api/assets/css/logo.png b/output/api/assets/css/logo.png index 609b336c..c82444af 100644 Binary files a/output/api/assets/css/logo.png and b/output/api/assets/css/logo.png differ diff --git a/output/api/assets/favicon.ico b/output/api/assets/favicon.ico new file mode 100644 index 00000000..414ac4fb Binary files /dev/null and b/output/api/assets/favicon.ico differ diff --git a/output/api/assets/favicon.png b/output/api/assets/favicon.png deleted file mode 100644 index 5a95ddab..00000000 Binary files a/output/api/assets/favicon.png and /dev/null differ diff --git a/output/api/classes/CLI.html b/output/api/classes/CLI.html index c1590890..1ebcc29e 100644 --- a/output/api/classes/CLI.html +++ b/output/api/classes/CLI.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,146 +25,106 @@

- Show: - - - - - - - -
- - + Show: + + + + + + + +
+
-

CLI Class

+

CLI Class

- - -
Defined in: lib/cli.js:9
- - - Module: yuidoc - - -
-

Parses the arguments, creates the options and passes them to Y.YUIDoc and then Y.DocBuilder.

-

Item Index

- - - -
- - - -
-
diff --git a/output/api/classes/DocBuilder.html b/output/api/classes/DocBuilder.html index 7fdd9fbe..723a8a8c 100644 --- a/output/api/classes/DocBuilder.html +++ b/output/api/classes/DocBuilder.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,106 +25,80 @@

- Show: - - - - - - - -
- - + Show: + + + + + + + +
+
-

DocBuilder Class

+

DocBuilder Class

- - -
Defined in: lib/builder.js:12
- - - Module: yuidoc - - -
-

Takes the JSON data from the DocParser class, creates and parses markdown and handlebars based templates to generate static HTML content

@@ -134,350 +106,204 @@

DocBuilder Class

-

Item Index

-

Methods

- -

Properties

- - -
-

Methods

- -
+

_addHelpers

-
(
    -
  • - helpers -
    • -
)
- - - - - - - -
- - -

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

- -
@@ -485,94 +311,57 @@

_addHelpers

-

Parameters:

    -
  • - helpers Object - -

    Object containing a hash of names and functions

    -
    • -
- - - -
- -
+
+

_inlineCode

-
(
    -
  • - html -
    • -
)
- - HTML - - - private - - - - -
- - -

- Defined in - - - - - lib/builder.js:778 - + lib/builder.js:773

- -
@@ -581,94 +370,57 @@

_inlineCode

-

Parameters:

    -
  • - html HTML - -

    The HTML to parse

    -
    • -
- -

Returns:

- - HTML: -

The parsed HTML

-
- - -
- -
+
+

_mixExternal

- () - - - - private - - - - -
- - -

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

- -
@@ -677,70 +429,40 @@

_mixExternal

- - - -
- -
+
+

_parseCode

-
(
    -
  • - html -
    • -
)
- - HTML - - - private - - - - -
- - -

- Defined in - - - - - lib/builder.js:765 - + lib/builder.js:760

- -
@@ -748,116 +470,69 @@

_parseCode

-

Parameters:

    -
  • - html HTML - -

    The HTML to parse

    -
    • -
- -

Returns:

- - HTML: -

The parsed HTML

-
- - -
- -
+
+

_parseCrossLink

-
(
    -
  • - item -
    • -
  • - [raw=false] -
    • -
  • - [content] -
    • -
)
- - - - private - - - - -
- - -

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

- -
@@ -865,126 +540,80 @@

_parseCrossLink

-

Parameters:

    -
  • - item String - -

    The item to crossLink

    -
    • -
  • - [raw=false] Boolean optional - -

    Do not wrap it in HTML

    -
    • -
  • - [content] String optional - -

    crossLink helper content

    -
    • -
- - - -
- -
+
+

addFoundAt

-
(
    -
  • - a -
    • -
)
- - String - - - - - - -
- - -

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

- -
@@ -992,106 +621,65 @@

addFoundAt

-

Parameters:

    -
  • - a Object - -

    The item to parse

    -
    • -
- -

Returns:

- - String: -

The parsed HREF

-
- - -
- -
+
+

augmentData

-
(
    -
  • - o -
    • -
)
- - Object - - - - - - -
- - -

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

- -
@@ -1100,102 +688,62 @@

augmentData

-

Parameters:

    -
  • - o Object - -

    The object to recurse and augment

    -
    • -
- -

Returns:

- - Object: -

The augmented object

-
- - -
- -
+
+

compile

-
(
    -
  • - cb -
    • -
)
- - - - - - - -
- - -

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

- -
@@ -1203,92 +751,56 @@

compile

-

Parameters:

    -
  • - cb Callback - -

    The callback to execute after it's completed

    -
    • -
- - - -
- -
+
+

filterFileName

-
(
    -
  • - f -
    • -
)
- - String - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:1602 - + lib/builder.js:1606

- -
@@ -1298,96 +810,59 @@

filterFileName

-

Parameters:

    -
  • - f String - -

    The filename to normalize

    -
    • -
- -

Returns:

- - String: -

The filtered file path

-
- - -
- -
+
+

getProjectMeta

- () - - Object - - - - - - -
- - -

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

- -
@@ -1395,88 +870,51 @@

getProjectMeta

- -

Returns:

- - Object: -

The project metadata

-
- - -
- -
+
+

hasProperty

-
(
    -
  • - a -
    • -
  • - b -
    • -
)
- - - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:1027 - + lib/builder.js:1026

- -
@@ -1484,116 +922,72 @@

hasProperty

-

Parameters:

    -
  • - a Array - -

    The Array of items to check

    -
    • -
  • - b Object - -

    The object to find

    -
    • -
- -

Returns:

- -

Boolean

-
- - -
- -
+
+

makeDirs

-
(
    -
  • - cb -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:712 - + lib/builder.js:707

- -
@@ -1601,94 +995,57 @@

makeDirs

-

Parameters:

    -
  • - cb Callback - -

    The callback to execute after it's completed

    -
    • -
- - - -
- -
+
+

markdown

-
(
    -
  • - md -
    • -
)
- - HTML - - - private - - - - -
- - -

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

- -
@@ -1696,114 +1053,68 @@

markdown

-

Parameters:

    -
  • - md String - -

    The Markdown string to parse

    -
    • -
- -

Returns:

- - HTML: -

The rendered HTML

-
- - -
- -
+
+

mergeExtends

-
(
    -
  • - info -
    • -
  • - classItems -
    • -
  • - first -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:1051 - + lib/builder.js:1050

- -
@@ -1811,122 +1122,76 @@

mergeExtends

-

Parameters:

    -
  • - info Object - -

    The item to extend

    -
    • -
  • - classItems Array - -

    The list of items to merge in

    -
    • -
  • - first Boolean - -

    Set for the first call

    -
    • -
- - - -
- -
+
+

mixExternal

-
(
    -
  • - cb -
    • -
)
- - - - - - - - async -
- - -

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

- -
@@ -1934,98 +1199,59 @@

mixExternal

-

Parameters:

    -
  • - cb Callback - -

    The callback to execute when complete

    -
    • -
- - - -
- -
+
+

nameSort

-
(
    -
  • - a -
    • -
  • - b -
    • -
)
- - Number - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:1432 - + lib/builder.js:1433

- -
@@ -2033,124 +1259,77 @@

nameSort

-

Parameters:

    -
  • - a Object - -

    First object to compare

    -
    • -
  • - b Object - -

    Second object to compare

    -
    • -
- -

Returns:

- - Number: -

1, -1 or 0 for sorting.

-
- - -
- -
+
+

NATIVES_LINKER

-
(
    -
  • - name -
    • -
)
- - String - - - private - - - - -
- - -

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

- -
@@ -2158,106 +1337,65 @@

NATIVES_LINKER

-

Parameters:

    -
  • - name String - -

    The name of the type to link

    -
    • -
- -

Returns:

- - String: -

The combined URL

-
- - -
- -
+
+

populateClasses

-
(
    -
  • - opts -
    • -
)
- - Object - - - - - - -
- - -

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

- -
@@ -2265,106 +1403,65 @@

populateClasses

-

Parameters:

    -
  • - opts Object - -

    The original options

    -
    • -
- -

Returns:

- - Object: -

The modified options

-
- - -
- -
+
+

populateFiles

-
(
    -
  • - opts -
    • -
)
- - Object - - - - - - -
- - -

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

- -
@@ -2372,106 +1469,65 @@

populateFiles

-

Parameters:

    -
  • - opts Object - -

    The original options

    -
    • -
- -

Returns:

- - Object: -

The modified options

-
- - -
- -
+
+

populateModules

-
(
    -
  • - opts -
    • -
)
- - Object - - - - - - -
- - -

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

- -
@@ -2479,126 +1535,74 @@

populateModules

-

Parameters:

    -
  • - opts Object - -

    The original options

    -
    • -
- -

Returns:

- - Object: -

The modified options

-
- - -
- -
+
+

render

-
(
    -
  • - source -
    • -
  • - view -
    • -
  • - [layout=null] -
    • -
  • - [partials={}] -
    • -
  • - callback -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:797 - + lib/builder.js:792

- -
@@ -2607,281 +1611,186 @@

render

-

Parameters:

    -
  • - source HTML - -

    The default template to parse

    -
    • -
  • - view Class - -

    The default view handler

    -
    • -
  • - [layout=null] HTML optional - -

    The HTML from the layout to use.

    -
    • -
  • - [partials={}] Object optional - -

    List of partials to include in this template

    -
    • -
  • - callback Callback - -
    -
      -
    • - err Error -
      -
      • -
    • - html HTML -

      The assembled template markup

      -
      • -
    -
    • -
- - - -
- -
+
+

renderAPIMeta

-
(
    -
  • - cb -
    • -
)
- - - - - - - - async -
- - -

- Defined in - - - - - lib/builder.js:1570 - + lib/builder.js:1573

- -
-

Render the API meta and return the Javascript

+

Render the API meta and return the JavaScript

-

Parameters:

    -
  • - cb Callback - -

    The callback

    - +
      +
    • + apijs + String + +
      +

      The JavaScript code to write API meta data

      + +
      + +
      • +
    • -
- - - -
- -
+
+

renderClass

-
(
    -
  • - cb - -
    • - -
  • - - cv.view -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:1103 - + lib/builder.js:1102

- -
@@ -2889,128 +1798,75 @@

renderClass

-

Parameters:

    -
  • - cb Function - -

    The callback fired when complete

    -
      -
    • - html String -

      The HTML to render this view

      -
      • - -
    - -
    • - -
  • - - cv.view - Object - - - +
  • + view + Object -
    -

    The View Data

    +
    +

    The View Data

    -
    +
    - +
    • +
-
- - - -
- -
+
+

renderFile

-
(
    -
  • - cb - -
    • - -
  • - - cv.view -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:1503 - + lib/builder.js:1506

- -
@@ -3018,128 +1874,75 @@

renderFile

-

Parameters:

    -
  • - cb Function - -

    The callback fired when complete

    -
      -
    • - html String -

      The HTML to render this view

      -
      • - -
    - -
    • - -
  • - - cv.view - Object - - - +
  • + view + Object -
    -

    The View Data

    +
    +

    The View Data

    -
    +
    - +
    • +
-
- - - -
- -
+
+

renderIndex

-
(
    -
  • - cb - -
    • - -
  • - - cv.view -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:853 - + lib/builder.js:848

- -
@@ -3147,128 +1950,75 @@

renderIndex

-

Parameters:

    -
  • - cb Function - -

    The callback fired when complete

    -
      -
    • - html String -

      The HTML to render this view

      -
      • - -
    - -
    • - -
  • - - cv.view - Object - - - +
  • + view + Object -
    -

    The View Data

    +
    +

    The View Data

    -
    +
    - +
    • +
-
- - - -
- -
+
+

renderModule

-
(
    -
  • - cb - -
    • - -
  • - - cv.view -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:902 - + lib/builder.js:899

- -
@@ -3276,124 +2026,76 @@

renderModule

-

Parameters:

    -
  • - cb Function - -

    The callback fired when complete

    -
      -
    • - html String -

      The HTML to render this view

      -
      • - -
    - -
    • - -
  • - - cv.view - Object - - - +
  • + view + Object -
    -

    The View Data

    +
    +

    The View Data

    -
    +
    - +
    • +
-
- - - -
- -
+
+

writeAPIMeta

-
(
    -
  • - cb -
    • -
)
- - - - - - - - async -
- - -

- Defined in - - - - - lib/builder.js:1557 - + lib/builder.js:1560

- -
@@ -3401,88 +2103,53 @@

writeAPIMeta

-

Parameters:

    -
  • - cb Callback - -

    The callback to execute when complete

    -
    • -
- - - -
- -
+
+

writeClasses

-
(
    -
  • - cb -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:1391 - + lib/builder.js:1390

- -
@@ -3490,88 +2157,75 @@

writeClasses

-

Parameters:

    -
  • - cb Callback - -

    The callback to execute after it's completed

    - -
    • - -
-
- - - - - -
+
    +
  • + html + String - -
    +
    +

    The HTML to write class view

    + +
    + +
    • +
  • + view + Object + +
    +

    The View Data

    + +
    + +
    • +
+ + +
+ + + +
+

writeFiles

-
(
    -
  • - cb -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:1455 - + lib/builder.js:1456

- -
@@ -3579,88 +2233,75 @@

writeFiles

-

Parameters:

    -
  • - cb Callback - -

    The callback to execute after it's completed

    - +
      +
    • + html + String + +
      +

      The HTML to write file view

      + +
      + +
      • +
    • + view + Object + +
      +

      The View Data

      + +
      + +
      • +
    • -
- - - -
- -
+
+

writeIndex

-
(
    -
  • - cb -
    • -
)
- - - - - - - -
- - -

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

- -
@@ -3668,88 +2309,75 @@

writeIndex

-

Parameters:

    -
  • - cb Callback - -

    The callback to execute after it's completed

    - +
      +
    • + html + String + +
      +

      The HTML to write index view

      + +
      + +
      • +
    • + view + Object + +
      +

      The View Data

      + +
      + +
      • +
    • -
- - - -
- -
+
+

writeModules

-
(
    -
  • - cb -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/builder.js:986 - + lib/builder.js:983

- -
@@ -3757,239 +2385,161 @@

writeModules

-

Parameters:

    -
  • - cb Callback - -

    The callback to execute after it's completed

    - +
      +
    • + html + String + +
      +

      The HTML to write module view

      + +
      + +
      • +
    • + view + Object + +
      +

      The View Data

      + +
      + +
      • +
    • -
- - - -
- +
- -

Properties

-
-

_mergeCounter

- Number - - - - - private - - - - - - -
- - - -

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

- - - - -
- -
-

Counter for stepping into merges

- -
- - - - - - -
- - +

_mergeCounter

+ Number + + + private + + + +
+

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

+ + +
+ +
+

Counter for stepping into merges

+ +
+ + + +
-

_meta

- Object - - - - - private - - - - - - -
- - - -

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

- - - - -
- -
-

Holder for project meta data

- -
- - - - - - -
- - +

_meta

+ Object + + + private + + + +
+

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

+ + +
+ +
+

Holder for project meta data

+ +
+ + + +
-

files

- Number - - - - - - - - - -
- - - -

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

- - - - -
- -
-

File counter

- -
- - - - - - -
- - +

files

+ Number + + + + + +
+

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

+ + +
+ +
+

File counter

+ +
+ + + +
-

NATIVES

- Object - - - - - - - - - -
- - - -

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

- - - - -
- -
-

List of native types to cross link to MDN

- -
- - - - - - -
- - +

NATIVES

+ Object + + + + + +
+

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

+ + +
+ +
+

List of native types to cross link to MDN

+ +
+ + + +
- - -
- diff --git a/output/api/classes/DocParser.html b/output/api/classes/DocParser.html index a7b2b978..db392866 100644 --- a/output/api/classes/DocParser.html +++ b/output/api/classes/DocParser.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,110 +25,83 @@

- Show: - - - - - - - -
- - + Show: + + + + + + + +
+
-

DocParser Class

+

DocParser Class

- -
Extends Base
- -
- Defined in: lib/docparser.js:735 + Defined in: lib/docparser.js:737
- - - Module: yuidoc - - -
-

The doc parser accepts a map of files to file content. Once parse() is called, various properties will be populated @@ -138,923 +109,547 @@

DocParser Class

-

Constructor

-

DocParser

- - -
- (
    - -
  • - - o - -
    • - -
) -
- - - - - - - - - - - - - - - - -
+

DocParser

+ +
+ (
    +
  • + o +
    • +
) +
- - -

- - Defined in + + + + + + + +

+

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

+ + + +
+ +
- +
+
+

Parameters:

- lib/docparser.js:735 +
    +
  • + o + Object -

    - - - +
    +

    the config object

    + +
    + +
    • +
+
+ -
- -
-
- - -
-

Parameters:

- -
    - -
  • - - o - Object - - - - -
    -

    the config object

    - -
    - - -
    • - -
- - - - - -
-
-

Item Index

-

Methods

- -

Properties

- -

Attributes

- -

Events

-
-

Methods

- -
+

_addAttrs

-
(
    -
  • - cfgs -
    • -
  • - values -
    • -
  • - lazy -
    • -
)
- - - - private - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:854 -

- -
@@ -1066,35 +661,25 @@

_addAttrs

-

Parameters:

    -
  • - cfgs Object - -

    An object with attribute name/configuration pairs.

    -
    • -
  • - values Object - -

    An object with attribute name/value pairs, defining the initial values to apply. @@ -1102,16 +687,11 @@

    Parameters:

    -
    • -
  • - lazy Boolean - -

    Whether or not to delay the intialization of these attributes until the first call to get/set. @@ -1120,74 +700,43 @@

    Parameters:

    -
    • -
- - - -
- -
+
+

_addLazyAttr

-
(
    -
  • - name -
    • -
  • - [lazyCfg] -
    • -
)
- - - - private - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:360 -

- -
@@ -1195,36 +744,26 @@

_addLazyAttr

-

Parameters:

    -
  • - name Object - -

    The name of the attribute

    -
    • -
  • - [lazyCfg] Object optional - -

    Optional config hash for the attribute. This is added for performance @@ -1232,74 +771,43 @@

    Parameters:

    -
    • -
- - - -
- -
+
+

_addOutOfOrder

-
(
    -
  • - name -
    • -
  • - cfg -
    • -
)
- - - - private - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:527 -

- -
@@ -1320,107 +828,68 @@

_addOutOfOrder

-

Parameters:

    -
  • - name String - -

    attribute name

    -
    • -
  • - cfg Object - -

    attribute configuration

    -
    • -
- - - -
- -
+
+

_aggregateAttrs

-
(
    -
  • - allAttrs -
    • -
)
- - Object - - - private - - - - -
- -

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

- -
@@ -1432,19 +901,14 @@

_aggregateAttrs

-

Parameters:

    -
  • - allAttrs Array - -

    An array of ATTRS definitions across classes in the hierarchy @@ -1452,72 +916,43 @@

    Parameters:

    -
    • -
- -

Returns:

- - Object: -

The aggregate set of ATTRS definitions for the instance

-
- - -
- -
+
+

_attrCfgHash

- () - - - - private - - - - -
- -

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

- -
@@ -1526,53 +961,31 @@

_attrCfgHash

- - - -
- -
+
+

_baseDestroy

- () - - - - private - - - - -
- -

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

- -
@@ -1580,53 +993,31 @@

_baseDestroy

- - - -
- -
+
+

_baseInit

- () - - - - private - - - - -
- -

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

- -
@@ -1634,63 +1025,37 @@

_baseInit

- - - -
- -
+
+

_cloneDefaultValue

-
(
    -
  • - cfg -
    • -
)
- - - - private - - - - -
- -

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

- -
@@ -1699,92 +1064,56 @@

_cloneDefaultValue

-

Parameters:

- - - -
- -
+
+

_defAttrChangeFn

-
(
    -
  • - e -
    • -
  • - eventFastPath -
    • -
)
- - - - private - - - - -
- -

Inherited from AttributeObservable: - - - attribute/js/AttributeObservable.js:185 -

- -
@@ -1792,103 +1121,65 @@

_defAttrChangeFn

-

Parameters:

    -
  • - e EventFacade - -

    The event object for attribute change events.

    -
    • -
  • - eventFastPath Boolean - -

    Whether or not we're using this as a fast path in the case of no listeners or not

    -
    • -
- - - -
- -
+
+

_defDestroyFn

-
(
    -
  • - e -
    • -
)
- - - - protected - - - - -
- -

Inherited from BaseObservable: - - - base/js/BaseObservable.js:202 -

- -
@@ -1896,87 +1187,54 @@

_defDestroyFn

-

Parameters:

- - - -
- -
+
+

_defInitFn

-
(
    -
  • - e -
    • -
)
- - - - protected - - - - -
- -

Inherited from BaseObservable: - - - base/js/BaseObservable.js:190 -

- -
@@ -1984,19 +1242,14 @@

_defInitFn

-

Parameters:

    -
  • - e EventFacade - -

    Event object, with a cfg property which @@ -2004,58 +1257,34 @@

    Parameters:

    -
    • -
- - - -
- -
+
+

_destroyHierarchy

- () - - - - private - - - - -
- -

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

- -
@@ -2064,92 +1293,57 @@

_destroyHierarchy

- - - -
- -
+
+

_filterAdHocAttrs

-
(
    -
  • - allAttrs -
    • -
  • - userVals -
    • -
)
- - Object - - - private - - - - -
- -

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

- -
-

Parameters:

    -
  • - allAttrs Object - -

    The set of all attribute configurations for this instance. @@ -2158,129 +1352,76 @@

    Parameters:

    -
    • -
  • - userVals Object - -

    The config object passed in by the user, from which adhoc attrs are to be filtered.

    -
    • -
- -

Returns:

- - Object: -

The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

-
- - -
- -
+
+

_fireAttrChange

-
(
    -
  • - attrName -
    • -
  • - subAttrName -
    • -
  • - currVal -
    • -
  • - newVal -
    • -
  • - opts -
    • -
  • - [cfg] -
    • -
)
- - - - private - - - - -
- -

Inherited from AttributeObservable: - - - attribute/js/AttributeObservable.js:120 -

- -
@@ -2288,35 +1429,25 @@

_fireAttrChange

-

Parameters:

    -
  • - attrName String - -

    The name of the attribute

    -
    • -
  • - subAttrName String - -

    The full path of the property being changed, @@ -2324,139 +1455,89 @@

    Parameters:

    -
    • -
  • - currVal Any - -

    The current value of the attribute

    -
    • -
  • - newVal Any - -

    The new value of the attribute

    -
    • -
  • - opts Object - -

    Any additional event data to mix into the attribute change event's event facade.

    -
    • -
  • - [cfg] Object optional - -

    The attribute config stored in State, if already available.

    -
    • -
- - - -
- -
+
+

_getAttr

-
(
    -
  • - name -
    • -
)
- - Any - - - protected - - - - chainable - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:564 -

- -
@@ -2466,105 +1547,66 @@

_getAttr

-

Parameters:

    -
  • - name String - -

    The name of the attribute.

    -
    • -
- -

Returns:

- - Any: -

The value of the attribute.

-
- - -
- -
+
+

_getAttrCfg

-
(
    -
  • - name -
    • -
)
- - Object - - - protected - - - - -
- -

Inherited from AttributeExtras: - - - attribute/js/AttributeExtras.js:125 -

- -
@@ -2574,95 +1616,60 @@

_getAttrCfg

-

Parameters:

    -
  • - name String - -

    Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

    -
    • -
- -

Returns:

- - Object: -

The configuration properties for the given attribute, or all attributes.

-
- - -
- -
+
+

_getAttrCfgs

- () - - Object - - - protected - - - - -
- -

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

- -
@@ -2671,95 +1678,57 @@

_getAttrCfgs

- -

Returns:

- - Object: -

The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.

-
- - -
- -
+
+

_getAttrInitVal

-
(
    -
  • - attr -
    • -
  • - cfg -
    • -
  • - initValues -
    • -
)
- - Any - - - private - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:963 -

- -
@@ -2770,137 +1739,88 @@

_getAttrInitVal

-

Parameters:

    -
  • - attr String - -

    The name of the attribute

    -
    • -
  • - cfg Object - -

    The attribute configuration object

    -
    • -
  • - initValues Object - -

    The object with simple and complex attribute name/value pairs returned from _normAttrVals

    -
    • -
- -

Returns:

- - Any: -

The initial value of the attribute.

-
- - -
- -
+
+

_getAttrs

-
(
    -
  • - attrs -
    • -
)
- - Object - - - protected - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:792 -

- -
@@ -2908,19 +1828,14 @@

_getAttrs

-

Parameters:

    -
  • - attrs String[] | Boolean - -

    Optional. An array of attribute names. If omitted, all attribute values are @@ -2928,76 +1843,46 @@

    Parameters:

    -
    • -
- -

Returns:

- - Object: -

An object with attribute name/value pairs.

-
- - -
- -
+
+

_getClasses

- () - - Function[] - - - protected - - - - -
- -

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

- -
@@ -3005,83 +1890,51 @@

_getClasses

- -

Returns:

- - Function[]: -

An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.

-
- - -
- -
+
+

_getFullType

-
(
    -
  • - type -
    • -
)
- - String - - - private - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:564 -

- -
@@ -3093,105 +1946,66 @@

_getFullType

-

Parameters:

    -
  • - type String - -

    The short type to prefix

    -
    • -
- -

Returns:

- - String: -

The prefixed type, if a prefix is set, otherwise the type passed in

-
- - -
- -
+
+

_getInstanceAttrCfgs

-
(
    -
  • - allCfgs -
    • -
)
- - Object - - - private - - - - -
- -

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

- -
@@ -3200,19 +2014,14 @@

_getInstanceAttrCfgs

-

Parameters:

    -
  • - allCfgs Object - -

    The set of all attribute configurations for this instance. @@ -3221,93 +2030,56 @@

    Parameters:

    -
    • -
- -

Returns:

- - Object: -

The set of attributes to be added for this instance, suitable for passing through to addAttrs.

-
- - -
- -
+
+

_getStateVal

-
(
    -
  • - name -
    • -
  • - [cfg] -
    • -
)
- - Any - - - private - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:618 -

- -
@@ -3316,36 +2088,26 @@

_getStateVal

-

Parameters:

    -
  • - name String - -

    The name of the attribute

    -
    • -
  • - [cfg] Object optional - -

    Optional config hash for the attribute. This is added for performance along the critical path, @@ -3353,72 +2115,43 @@

    Parameters:

    -
    • -
- -

Returns:

- - Any: -

The stored value of the attribute

-
- - -
- -
+
+

_getType

- () - - - - private - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:36 -

- -
@@ -3428,180 +2161,109 @@

_getType

- - - -
- -
+
+

_hasPotentialSubscribers

-
(
    -
  • - fullType -
    • -
)
- - Boolean - - - private - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-facade.js:643 -

- -
-

Parameters:

    -
  • - fullType String - -

    The fully prefixed type name

    -
    • -
- -

Returns:

- - Boolean: -

Whether the event has potential subscribers or not

-
- - -
- -
+
+

_initAttrHost

-
(
    -
  • - attrs -
    • -
  • - values -
    • -
  • - lazy -
    • -
)
- - - - private - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:140 -

- -
@@ -3610,19 +2272,14 @@

_initAttrHost

-

Parameters:

    -
  • - attrs Object - -

    The attributes to add during construction (passed through to addAttrs). @@ -3630,16 +2287,11 @@

    Parameters:

    -
    • -
  • - values Object - -

    The initial attribute values to apply (passed through to addAttrs). @@ -3647,77 +2299,48 @@

    Parameters:

    -
    • -
  • - lazy Boolean - -

    Whether or not to add attributes lazily (passed through to addAttrs).

    -
    • -
- - - -
- -
+
+

_initAttribute

- () - - - - private - - - - -
-

Inherited from BaseObservable - but overwritten in - - - base/js/BaseCore.js:309 -

- -
@@ -3725,75 +2348,43 @@

_initAttribute

- - - -
- -
+
+

_initAttrs

-
(
    -
  • - attrs -
    • -
  • - values -
    • -
  • - lazy -
    • -
)
- - - - protected - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:1029 -

- -
@@ -3802,19 +2393,14 @@

_initAttrs

-

Parameters:

    -
  • - attrs Object - -

    The attributes to add during construction (passed through to addAttrs). @@ -3822,16 +2408,11 @@

    Parameters:

    -
    • -
  • - values Object - -

    The initial attribute values to apply (passed through to addAttrs). @@ -3839,84 +2420,51 @@

    Parameters:

    -
    • -
  • - lazy Boolean - -

    Whether or not to add attributes lazily (passed through to addAttrs).

    -
    • -
- - - -
- -
+
+

_initBase

-
(
    -
  • - config -
    • -
)
- - - - private - - - - -
- -

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

- -
@@ -3924,87 +2472,54 @@

_initBase

-

Parameters:

    -
  • - config Object - -

    The constructor configuration object

    -
    • -
- - - -
- -
+
+

_initHierarchy

-
(
    -
  • - userVals -
    • -
)
- - - - private - - - - -
- -

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

- -
@@ -4015,77 +2530,48 @@

_initHierarchy

-

Parameters:

    -
  • - userVals Object - -

    Object with configuration property name/value pairs

    -
    • -
- - - -
- -
+
+

_initHierarchyData

- () - - - - private - - - - -
- -

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

- -
@@ -4095,67 +2581,40 @@

_initHierarchyData

- - - -
- -
+
+

_isLazyAttr

-
(
    -
  • - name -
    • -
)
- - Boolean - - - private - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:347 -

- -
@@ -4164,113 +2623,69 @@

_isLazyAttr

-

Parameters:

    -
  • - name String - -

    The name of the attribute

    -
    • -
- -

Returns:

- - Boolean: -

true if it's a lazily added attribute, false otherwise.

-
- - -
- -
+
+

_monitor

-
(
    -
  • - what -
    • -
  • - eventType -
    • -
  • - o -
    • -
)
- - - - private - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:636 -

- -
@@ -4285,51 +2700,36 @@

_monitor

-

Parameters:

    -
  • - what String - -

    'attach', 'detach', 'fire', or 'publish'

    -
    • -
  • - eventType String | CustomEvent - -

    The prefixed name of the event being monitored, or the CustomEvent object.

    -
    • -
  • - o Object - -

    Information about the event interaction, such as @@ -4337,72 +2737,43 @@

    Parameters:

    -
    • -
- - - -
- -
+
+

_normAttrVals

-
(
    -
  • - valueHash -
    • -
)
- - Object - - - private - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:915 -

- -
@@ -4411,93 +2782,59 @@

_normAttrVals

-

Parameters:

    -
  • - valueHash Object - -

    An object with attribute name/value pairs

    -
    • -
- -

Returns:

- - Object: -

An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.

-
- - -
- -
+
+

_parseType

- () - - - - private - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:52 -

- -
@@ -4507,63 +2844,37 @@

_parseType

- - - -
- -
+
+

_preInitEventCfg

-
(
    -
  • - config -
    • -
)
- - - - private - - - - -
- -

Inherited from BaseObservable: - - - base/js/BaseObservable.js:110 -

- -
@@ -4573,97 +2884,61 @@

_preInitEventCfg

-

Parameters:

    -
  • - config Object - -

    The user configuration object

    -
    • -
- - - -
- -
+
+

_protectAttrs

-
(
    -
  • - attrs -
    • -
)
- - Object - - deprecated - - protected - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:901 -

-

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

- -
@@ -4673,117 +2948,72 @@

_protectAttrs

-

Parameters:

    -
  • - attrs Object - -

    A hash of attribute to configuration object pairs.

    -
    • -
- -

Returns:

- - Object: -

A protected version of the attrs argument.

-
- - -
- -
+
+

_publish

-
(
    -
  • - fullType -
    • -
  • - etOpts -
    • -
  • - ceOpts -
    • -
)
- - CustomEvent - - - private - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:588 -

- -
@@ -4793,141 +3023,89 @@

_publish

-

Parameters:

    -
  • - fullType String - -

    The prefixed type of the event to publish.

    -
    • -
  • - etOpts Object - -

    The EventTarget specific configuration to mix into the published event.

    -
    • -
  • - ceOpts Object - -

    The publish specific configuration to mix into the published event.

    -
    • -
- -

Returns:

- - CustomEvent: -

The published event. If called without etOpts or ceOpts, this will be the default CustomEvent instance, and can be configured independently.

-
- - -
- -
+
+

_resolveFor

-
(
    -
  • - value -
    • -
)
- - String - - - private - - - - -
- - -

- Defined in - - - - - lib/docparser.js:1019 - + lib/docparser.js:1021

- -
@@ -4935,122 +3113,76 @@

_resolveFor

-

Parameters:

    -
  • - value String - -

    The classname to resolve

    -
    • -
- -

Returns:

- - String: -

The resolved namespace + classname

-
- - -
- -
+
+

_set

-
(
    -
  • - name -
    • -
  • - val -
    • -
  • - [opts] -
    • -
)
- - Object - - - protected - - - - chainable - -
-

Inherited from AttributeObservable - but overwritten in - - - attribute/js/AttributeCore.js:405 -

- -
@@ -5058,158 +3190,99 @@

_set

-

Parameters:

    -
  • - name String - -

    The name of the attribute.

    -
    • -
  • - val Any - -

    The value to set the attribute to.

    -
    • -
  • - [opts] Object optional - -

    Optional data providing the circumstances for the change.

    -
    • -
- -

Returns:

- - Object: -

A reference to the host object.

-
- - -
- -
+
+

_setAttr

-
(
    -
  • - name -
    • -
  • - value -
    • -
  • - [opts] -
    • -
  • - force -
    • -
)
- - Object - - - protected - - - - chainable - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:421 -

- -
@@ -5218,68 +3291,48 @@

_setAttr

-

Parameters:

    -
  • - name String - -

    The name of the attribute.

    -
    • -
  • - value Any - -

    The value to set the attribute to.

    -
    • -
  • - [opts] Object optional - -

    Optional data providing the circumstances for the change.

    -
    • -
  • - force Boolean - -

    If true, allows the caller to set values for @@ -5287,97 +3340,59 @@

    Parameters:

    -
    • -
- -

Returns:

- - Object: -

A reference to the host object.

-
- - -
- -
+
+

_setAttrs

-
(
    -
  • - attrs -
    • -
  • - [opts] -
    • -
)
- - Object - - - protected - - - - chainable - -
-

Inherited from AttributeObservable - but overwritten in - - - attribute/js/AttributeCore.js:760 -

- -
@@ -5385,152 +3400,93 @@

_setAttrs

-

Parameters:

    -
  • - attrs Object - -

    An object with attributes name/value pairs.

    -
    • -
  • - [opts] Object optional - -

    Optional data providing the circumstances for the change

    -
    • -
- -

Returns:

- - Object: -

A reference to the host object.

-
- - -
- -
+
+

_setAttrVal

-
(
    -
  • - attrName -
    • -
  • - subAttrName -
    • -
  • - prevVal -
    • -
  • - newVal -
    • -
  • - [opts] -
    • -
  • - [attrCfg] -
    • -
)
- - Boolean - - - private - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:658 -

- -
@@ -5539,101 +3495,71 @@

_setAttrVal

-

Parameters:

    -
  • - attrName String - -

    The attribute name.

    -
    • -
  • - subAttrName String - -

    The sub-attribute name, if setting a sub-attribute property ("x.y.z").

    -
    • -
  • - prevVal Any - -

    The currently stored value of the attribute.

    -
    • -
  • - newVal Any - -

    The value which is going to be stored.

    -
    • -
  • - [opts] Object optional - -

    Optional data providing the circumstances for the change.

    -
    • -
  • - [attrCfg] Object optional - -

    Optional config hash for the attribute. This is added for performance along the critical path, @@ -5641,88 +3567,52 @@

    Parameters:

    -
    • -
- -

Returns:

- - Boolean: -

true if the new attribute value was stored, false if not.

-
- - -
- -
+
+

_setStateVal

-
(
    -
  • - name -
    • -
  • - value -
    • -
)
- - - - private - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:640 -

- -
@@ -5731,119 +3621,74 @@

_setStateVal

-

Parameters:

    -
  • - name String - -

    The name of the attribute

    -
    • -
  • - value Any - -

    The value of the attribute

    -
    • -
- - - -
- -
+
+

addAttr

-
(
    -
  • - name -
    • -
  • - config -
    • -
  • - lazy -
    • -
)
- - Object - - - - - - chainable - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:157 -

- -
@@ -5929,35 +3774,25 @@

addAttr

and are not intended for public use.

-

Parameters:

    -
  • - name String - -

    The name of the attribute.

    -
    • -
  • - config Object - -

    An object with attribute configuration property/value pairs, specifying the configuration for the attribute.

    @@ -5967,114 +3802,69 @@

    Parameters:

    -
    • -
  • - lazy Boolean - -

    (optional) Whether or not to add this attribute lazily (on the first call to get/set).

    -
    • -
- -

Returns:

- - Object: -

A reference to the host object.

-
- - -
- -
+
+

addAttrs

-
(
    -
  • - cfgs -
    • -
  • - values -
    • -
  • - lazy -
    • -
)
- - Object - - - - - - chainable - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:823 -

- -
@@ -6085,35 +3875,25 @@

addAttrs

-

Parameters:

    -
  • - cfgs Object - -

    An object with attribute name/configuration pairs.

    -
    • -
  • - values Object - -

    An object with attribute name/value pairs, defining the initial values to apply. @@ -6121,16 +3901,11 @@

    Parameters:

    -
    • -
  • - lazy Boolean - -

    Whether or not to delay the intialization of these attributes until the first call to get/set. @@ -6139,82 +3914,49 @@

    Parameters:

    -
    • -
- -

Returns:

- - Object: -

A reference to the host object.

-
- - -
- -
+
+

addTarget

-
(
    -
  • - o -
    • -
)
- - - - - - - chainable - -
- -

Inherited from EventTarget: - - - event-custom/js/event-facade.js:496 -

- -
@@ -6226,107 +3968,65 @@

addTarget

-

Parameters:

- - - -
- -
+
+

after

-
(
    -
  • - type -
    • -
  • - fn -
    • -
  • - [context] -
    • -
  • - [arg*] -
    • -
)
- - EventHandle - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:812 -

- -
@@ -6337,154 +4037,101 @@

after

-

Parameters:

    -
  • - type String - -

    The name of the event

    -
    • -
  • - fn Function - -

    The callback to execute in response to the event

    -
    • -
  • - [context] Object optional - -

    Override this object in callback

    -
    • -
  • - [arg*] Any optional - -

    0..n additional arguments to supply to the subscriber

    -
    • -
- -

Returns:

- - EventHandle: -

A subscription handle capable of detaching the subscription

-
- - -
- -
+
+

attrAdded

-
(
    -
  • - name -
    • -
)
- - Boolean - - - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:319 -

- -
@@ -6492,94 +4139,60 @@

attrAdded

-

Parameters:

    -
  • - name String - -

    The name of the attribute to check.

    -
    • -
- -

Returns:

- - Boolean: -

true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.

-
- - -
- -
+
+

before

- () - - - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:849 -

- -
@@ -6594,77 +4207,47 @@

before

- -

Returns:

- -

detach handle

-
- - -
- -
+
+

bubble

-
(
    -
  • - evt -
    • -
)
- - Boolean - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-facade.js:554 -

- -
@@ -6672,98 +4255,63 @@

bubble

-

Parameters:

    -
  • - evt CustomEvent - -

    the custom event to propagate

    -
    • -
- -

Returns:

- - Boolean: -

the aggregated return value from Event.Custom.fire

-
- - -
- -
+
+

destroy

- () - - BaseCore - - - - - - chainable - -
-

Inherited from BaseObservable - but overwritten in - - - base/js/BaseCore.js:352 -

- -
@@ -6771,91 +4319,54 @@

destroy

- -

Returns:

- - BaseCore: -

A reference to this object

-
- - -
- -
+
+

detach

-
(
    -
  • - type -
    • -
  • - fn -
    • -
  • - context -
    • -
)
- - EventTarget - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:356 -

- -
@@ -6863,19 +4374,14 @@

detach

-

Parameters:

    -
  • - type String | Object - -

    Either the handle to the subscriber or the @@ -6885,16 +4391,11 @@

    Parameters:

    -
    • -
  • - fn Function - -

    The subscribed function to unsubscribe, if not @@ -6902,16 +4403,11 @@

    Parameters:

    -
    • -
  • - context Object - -

    The custom object passed to subscribe. This is @@ -6922,80 +4418,48 @@

    Parameters:

    -
    • -
- -

Returns:

- - EventTarget: -

the host

-
- - -
- -
+
+

detachAll

-
(
    -
  • - type -
    • -
)
- - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:479 -

- -
@@ -7005,98 +4469,59 @@

detachAll

-

Parameters:

    -
  • - type String - -

    The type, or name of the event

    -
    • -
- - - -
- -
+
+

extract

-
(
    -
  • - filemap -
    • -
  • - dirmap -
    • -
)
- - Object - - - - - - -
- - -

- Defined in - - - - - lib/docparser.js:1190 - + lib/docparser.js:1192

- -
@@ -7109,126 +4534,80 @@

extract

-

Parameters:

    -
  • - filemap Object - -

    A map of filenames to file content

    -
    • -
  • - dirmap Array - -

    A map of file names to directory name

    -
    • -
- -

Returns:

- - Object: -

A map of filenames to an array of extracted comment text.

-
- - -
- -
+
+

fire

-
(
    -
  • - type -
    • -
  • - arguments -
    • -
)
- - Boolean - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:673 -

- -
@@ -7248,19 +4627,14 @@

fire

-

Parameters:

    -
  • - type String | Object - -

    The type of the event, or an object that contains @@ -7268,16 +4642,11 @@

    Parameters:

    -
    • -
  • - arguments Object* - -

    an arbitrary set of parameters to pass to @@ -7288,85 +4657,52 @@

    Parameters:

    -
    • -
- -

Returns:

- - Boolean: -

True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.

-
- - -
- -
+
+

get

-
(
    -
  • - name -
    • -
)
- - Any - - - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:331 -

- -
@@ -7376,19 +4712,14 @@

get

-

Parameters:

    -
  • - name String - -

    The name of the attribute. If the value of the attribute is an Object, @@ -7396,84 +4727,51 @@

    Parameters:

    -
    • -
- -

Returns:

- - Any: -

The value of the attribute

-
- - -
- -
+
+

getAttrs

-
(
    -
  • - attrs -
    • -
)
- - Object - - - - - - -
- -

Inherited from AttributeCore: - - - attribute/js/AttributeCore.js:780 -

- -
@@ -7481,19 +4779,14 @@

getAttrs

-

Parameters:

    -
  • - attrs String[] | Boolean - -

    Optional. An array of attribute names. If omitted, all attribute values are @@ -7501,90 +4794,54 @@

    Parameters:

    -
    • -
- -

Returns:

- - Object: -

An object with attribute name/value pairs.

-
- - -
- -
+
+

getEvent

-
(
    -
  • - type -
    • -
  • - prefixed -
    • -
)
- - CustomEvent - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:793 -

- -
@@ -7593,109 +4850,70 @@

getEvent

-

Parameters:

    -
  • - type String - -

    the type, or name of the event

    -
    • -
  • - prefixed String - -

    if true, the type is prefixed already

    -
    • -
- -

Returns:

- - CustomEvent: -

the custom event or null

-
- - -
- -
+
+

getTargets

- () - - - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-facade.js:523 -

- -
@@ -7703,88 +4921,50 @@

getTargets

- -

Returns:

- -

EventTarget[]

-
- - -
- -
+
+

handlecomment

-
(
    -
  • - comment -
    • -
  • - file -
    • -
  • - line -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/docparser.js:1114 - + lib/docparser.js:1116

- -
@@ -7795,126 +4975,79 @@

handlecomment

-

Parameters:

    -
  • - comment String - -

    The comment to parse

    -
    • -
  • - file String - -

    The file it was parsed from

    -
    • -
  • - line String - -

    The line number it was found on

    -
    • -
- - - -
- -
+
+

implodeString

-
(
    -
  • - str -
    • -
)
- - String - - - private - - - - -
- - -

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

- -
@@ -7922,108 +5055,66 @@

implodeString

-

Parameters:

    -
  • - str String - -

    The string to operate on

    -
    • -
- -

Returns:

- - String: -

The modified string

-
- - -
- -
+
+

implodeString

-
(
    -
  • - str -
    • -
)
- - String - - - private - - - - -
- - -

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

- -
@@ -8031,108 +5122,69 @@

implodeString

-

Parameters:

    -
  • - str String - -

    The string to operate on

    -
    • -
- -

Returns:

- - String: -

The modified string

-
- - -
- -
+
+

init

-
(
    -
  • - cfg -
    • -
)
- - BaseCore - - - - - - chainable - -
-

Inherited from BaseObservable - but overwritten in - - - base/js/BaseCore.js:319 -

- -
@@ -8141,105 +5193,65 @@

init

-

Parameters:

    -
  • - cfg Object - -

    Object with configuration property name/value pairs

    -
    • -
- -

Returns:

- - BaseCore: -

A reference to this object

-
- - -
- -
+
+

modifyAttr

-
(
    -
  • - name -
    • -
  • - config -
    • -
)
- - - - - - - -
- -

Inherited from AttributeExtras: - - - attribute/js/AttributeExtras.js:40 -

- -
@@ -8264,123 +5276,76 @@

modifyAttr

-

Parameters:

    -
  • - name String - -

    The name of the attribute whose configuration is to be updated.

    -
    • -
  • - config Object - -

    An object with configuration property/value pairs, specifying the configuration properties to modify.

    -
    • -
- - - -
- -
+
+

on

-
(
    -
  • - type -
    • -
  • - fn -
    • -
  • - [context] -
    • -
  • - [arg*] -
    • -
)
- - EventHandle - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:188 -

- -
@@ -8409,172 +5374,110 @@

on

-

Parameters:

    -
  • - type String - -

    The name of the event

    -
    • -
  • - fn Function - -

    The callback to execute in response to the event

    -
    • -
  • - [context] Object optional - -

    Override this object in callback

    -
    • -
  • - [arg*] Any optional - -

    0..n additional arguments to supply to the subscriber

    -
    • -
- -

Returns:

- - EventHandle: -

A subscription handle capable of detaching that subscription

-
- - -
- -
+
+

once

-
(
    -
  • - type -
    • -
  • - fn -
    • -
  • - [context] -
    • -
  • - [arg*] -
    • -
)
- - EventHandle - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:124 -

- -
@@ -8584,172 +5487,110 @@

once

-

Parameters:

    -
  • - type String - -

    The name of the event

    -
    • -
  • - fn Function - -

    The callback to execute in response to the event

    -
    • -
  • - [context] Object optional - -

    Override this object in callback

    -
    • -
  • - [arg*] Any optional - -

    0..n additional arguments to supply to the subscriber

    -
    • -
- -

Returns:

- - EventHandle: -

A subscription handle capable of detaching the subscription

-
- - -
- -
+
+

onceAfter

-
(
    -
  • - type -
    • -
  • - fn -
    • -
  • - [context] -
    • -
  • - [arg*] -
    • -
)
- - EventHandle - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:146 -

- -
@@ -8759,163 +5600,104 @@

onceAfter

-

Parameters:

    -
  • - type String - -

    The name of the event

    -
    • -
  • - fn Function - -

    The callback to execute in response to the event

    -
    • -
  • - [context] Object optional - -

    Override this object in callback

    -
    • -
  • - [arg*] Any optional - -

    0..n additional arguments to supply to the subscriber

    -
    • -
- -

Returns:

- - EventHandle: -

A subscription handle capable of detaching that subscription

-
- - -
- -
+
+

parse

-
(
    -
  • - filemap -
    • -
  • - dirmap -
    • -
)
- - DocParser - - - - - - -
- - -

- Defined in - - - - - lib/docparser.js:1432 - + lib/docparser.js:1434

- -
@@ -8923,128 +5705,81 @@

parse

-

Parameters:

    -
  • - filemap Array - -

    A map of filenames to file content

    -
    • -
  • - dirmap Array - -

    A map of file names to directory name

    -
    • -
- -

Returns:

- - DocParser: -

this parser instance. The total results are available in parser.data.

-
- - -
- -
+
+

parseType

-
(
    -
  • - type -
    • -
  • - [pre] -
    • -
)
- - Array - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:168 -

- -

Available since 3.3.0

-
@@ -9056,58 +5791,41 @@

parseType

-

Parameters:

    -
  • - type String - -

    the type

    -
    • -
  • - [pre] String optional - -

    The prefix. Defaults to this._yuievt.config.prefix

    -
    • -
- -

Returns:

- - Array: -

an array containing:

  • the detach category, if supplied,
    • @@ -9116,65 +5834,37 @@

    Returns:

  • the supplied event type
-
- - -
- -
+
+

processblock

-
(
    -
  • - an -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/docparser.js:1245 - + lib/docparser.js:1247

- -
@@ -9182,95 +5872,59 @@

processblock

-

Parameters:

    -
  • - an Array - -

    array of the tag/text pairs

    -
    • -
- - - -
- -
+
+

publish

-
(
    -
  • - type -
    • -
  • - opts -
    • -
)
- - CustomEvent - - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:503 -

- -
@@ -9280,50 +5934,36 @@

publish

-

Parameters:

    -
  • - type String - -

    the type, or name of the event

    -
    • -
  • - opts Object - -

    optional config params. Valid properties are:

    -
      -
    • - [broadcast=false] Boolean optional -

      whether or not the YUI instance and YUI global @@ -9331,15 +5971,11 @@

      Parameters:

      -
      • -
    • - [bubbles=true] Boolean optional -

      Whether or not this event bubbles. Events can @@ -9347,30 +5983,22 @@

      Parameters:

      -
      • -
    • - [context=this] Object optional -

      the default execution context for the listeners.

      -
      • -
    • - [defaultFn] Function optional -

      the default function to execute when this event @@ -9378,45 +6006,33 @@

      Parameters:

      -
      • -
    • - [emitFacade=false] Boolean optional -

      whether or not this event emits a facade.

      -
      • -
    • - [prefix] String optional -

      the prefix for this targets events, e.g., 'menu' in 'menu:click'.

      -
      • -
    • - [fireOnce=false] Boolean optional -

      if an event is configured to fire once, @@ -9424,15 +6040,11 @@

      Parameters:

      -
      • -
    • - [async=false] Boolean optional -

      fireOnce event listeners will fire synchronously @@ -9440,90 +6052,66 @@

      Parameters:

      -
      • -
    • - [preventable=true] Boolean optional -

      whether or not preventDefault() has an effect.

      -
      • -
    • - [preventedFn] Function optional -

      a function that is executed when preventDefault() is called.

      -
      • -
    • - [queuable=false] Boolean optional -

      whether or not this event can be queued during bubbling.

      -
      • -
    • - [silent] Boolean optional -

      if silent is true, debug messages are not provided for this event.

      -
      • -
    • - [stoppedFn] Function optional -

      a function that is executed when stopPropagation is called.

      -
      • -
    • - [monitored] Boolean optional -

      specifies whether or not this event should send notifications about @@ -9531,99 +6119,61 @@

      Parameters:

      -
      • -
    • - [type] String optional -

      the event type (valid option if not provided as the first parameter to publish).

      -
      • -
    -
    • -
- -

Returns:

- - CustomEvent: -

the custom event

-
- - -
- -
+
+

removeAttr

-
(
    -
  • - name -
    • -
)
- - - - - - - -
- -

Inherited from AttributeExtras: - - - attribute/js/AttributeExtras.js:90 -

- -
@@ -9631,87 +6181,54 @@

removeAttr

-

Parameters:

    -
  • - name String - -

    The name of the attribute to be removed.

    -
    • -
- - - -
- -
+
+

removeTarget

-
(
    -
  • - o -
    • -
)
- - - - - - - chainable - -
- -

Inherited from EventTarget: - - - event-custom/js/event-facade.js:533 -

- -
@@ -9719,91 +6236,57 @@

removeTarget

-

Parameters:

- - - -
- -
+
+

reset

-
(
    -
  • - name -
    • -
)
- - Object - - - - - - chainable - -
- -

Inherited from AttributeExtras: - - - attribute/js/AttributeExtras.js:100 -

- -
@@ -9812,120 +6295,75 @@

reset

-

Parameters:

    -
  • - name String - -

    Optional. The name of the attribute to reset. If omitted, all attributes are reset.

    -
    • -
- -

Returns:

- - Object: -

A reference to the host object.

-
- - -
- -
+
+

set

-
(
    -
  • - name -
    • -
  • - value -
    • -
  • - [opts] -
    • -
)
- - Object - - - - - - chainable - -
-

Inherited from AttributeObservable - but overwritten in - - - attribute/js/AttributeCore.js:388 -

- -
@@ -9933,19 +6371,14 @@

set

-

Parameters:

    -
  • - name String - -

    The name of the attribute. If the @@ -9954,128 +6387,81 @@

    Parameters:

    -
    • -
  • - value Any - -

    The value to set the attribute to.

    -
    • -
  • - [opts] Object optional - -

    Optional data providing the circumstances for the change.

    -
    • -
- -

Returns:

- - Object: -

A reference to the host object.

-
- - -
- -
+
+

setAttrs

-
(
    -
  • - attrs -
    • -
  • - [opts] -
    • -
)
- - Object - - - - - - chainable - -
-

Inherited from AttributeObservable - but overwritten in - - - attribute/js/AttributeCore.js:747 -

- -
@@ -10083,125 +6469,78 @@

setAttrs

-

Parameters:

    -
  • - attrs Object - -

    An object with attributes name/value pairs.

    -
    • -
  • - [opts] Object optional - -

    Optional data providing the circumstances for the change.

    -
    • -
- -

Returns:

- - Object: -

A reference to the host object.

-
- - -
- -
+
+

stringlog

-
(
    -
  • - data -
    • -
)
- - String - - - private - - - - -
- - -

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

- -
@@ -10210,93 +6549,58 @@

stringlog

-

Parameters:

    -
  • - data Object - -

    The data block from the parser

    -
    • -
- -

Returns:

- - String: -

The formatted string.

-
- - -
- -
+
+

subscribe

- () - - - deprecated - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:346 -

-

Deprecated: use on

- -
@@ -10304,55 +6608,33 @@

subscribe

- - - -
- -
+
+

toString

- () - - String - - - - - - -
- -

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

- -
@@ -10361,82 +6643,48 @@

toString

- -

Returns:

- - String: -

String representation for this object

-
- - -
- -
+
+

transform

-
(
    -
  • - commentmap -
    • -
)
- - Object - - - - - - -
- - -

- Defined in - - - - - lib/docparser.js:1318 - + lib/docparser.js:1320

- -
@@ -10446,108 +6694,66 @@

transform

-

Parameters:

    -
  • - commentmap Object - -

    The hash of files and parsed comment blocks

    -
    • -
- -

Returns:

- - Object: -

The transformed data for the project

-
- - -
- -
+
+

unindent

-
(
    -
  • - content -
    • -
)
- - String - - - private - - - - -
- - -

- Defined in - - - - - lib/docparser.js:1093 - + lib/docparser.js:1095

- -
@@ -10558,93 +6764,58 @@

unindent

-

Parameters:

    -
  • - content String - -

    Text to unindent.

    -
    • -
- -

Returns:

- - String: -

Unindented text.

-
- - -
- -
+
+

unsubscribe

- () - - - deprecated - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:469 -

-

Deprecated: use detach

- -
@@ -10652,65 +6823,38 @@

unsubscribe

- - - -
- -
+
+

unsubscribeAll

-
(
    -
  • - type -
    • -
)
- - - deprecated - - - - - -
- -

Inherited from EventTarget: - - - event-custom/js/event-target.js:490 -

-

Deprecated: use detachAll

- -
@@ -10720,1710 +6864,1255 @@

unsubscribeAll

-

Parameters:

    -
  • - type String - -

    The type, or name of the event

    -
    • -
- - - -
- +
- -

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)

- - - - - -
- - +

_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:174 - -

- - - - -
- -
-

Common errors will get scrubbed instead of being ignored.

- -
- - - - - - -
- - +

CORRECTIONS

+ Object + + + + final + + +
+

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

+ + +
+ +
+

Common errors will get scrubbed instead of being ignored.

+ +
+ + + +
-

DIGESTERS

- Object - - - - - - - final - - - - -
- - - -

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

- - - - -
- -
-

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.

- -
- - - - - - -
- - +

DIGESTERS

+ Object + + + + final + + +
+

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

+ + +
+ +
+

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.

+ +
+ + + +
-

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.

- -
- - - - - - -
- - +

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:94 - -

- - - - -
- -
-

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

- -
- - - - - - -
- - +

TAGLIST

+ Array + + + + final + + +
+

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

+ + +
+ +
+

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

+ +
+ + + +
- -

Attributes

-
- -

currentclass

- String - - - - - - - - - - - - - - - -
- - - -

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

- - - - -
- -
-

The class currently being parsed

- -
- - - - -
-

Fires event currentclassChange

- -

- Fires when the value for the configuration attribute currentclass is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +

    currentclass

    + String + + + + + + + + +
    +

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

    + +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - -
- -

currentfile

- String - - - - - - - - - - - - - - - -
- - - -

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

- - - - -
- -
-

The file currently being parsed

- -
- - - - -
-

Fires event currentfileChange

- -

- Fires when the value for the configuration attribute currentfile is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +
    +

    The class currently being parsed

    +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - + + +
+

Fires event currentclassChange

+ +

+ Fires when the value for the configuration attribute currentclass is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ +
+
+ +

currentfile

+ String + + + + + + + + +
+

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

+ + +
+ +
+

The file currently being parsed

+ +
+ + +
+

Fires event currentfileChange

+ +

+ Fires when the value for the configuration attribute currentfile is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ +
- -

currentmodule

- String - - - - - - - - - - - - - - - -
- - - -

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

- - - - -
- -
-

The module currently being parsed

- -
- - - - -
-

Fires event currentmoduleChange

- -

- Fires when the value for the configuration attribute currentmodule is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +

    currentmodule

    + String + + + + + + + + +
    +

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

    + +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - + +
+

The module currently being parsed

+ +
+ + +
+

Fires event currentmoduleChange

+ +

+ Fires when the value for the configuration attribute currentmodule is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ +
- -

currentsubmodule

- String - - - - - - - - - - - - - - - -
- - - -

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

- - - - -
- -
-

The submodule currently being parsed

- -
- - - - -
-

Fires event currentsubmoduleChange

- -

- Fires when the value for the configuration attribute currentsubmodule is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +

    currentsubmodule

    + String + + + + + + + + +
    +

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

    + +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - + +
+

The submodule currently being parsed

+ +
+ + +
+

Fires event currentsubmoduleChange

+ +

+ Fires when the value for the configuration attribute currentsubmodule is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ +
- -

destroyed

- Boolean - - - - - - - - - - - - - - - readonly - - -
- - -

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

- - - - -
- -
-

Flag indicating whether or not this object -has been through the destroy lifecycle phase.

- -
- - -

Default: false

- - - -
-

Fires event destroyedChange

- -

- Fires when the value for the configuration attribute destroyed is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +

    destroyed

    + Boolean + + + + + + + + readonly + +
    +

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

    + +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - + +
+

Flag indicating whether or not this object + has been through the destroy lifecycle phase.

+ +
+ +

Default: false

+ +
+

Fires event destroyedChange

+ +

+ Fires when the value for the configuration attribute destroyed is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ +
- -

digesters

- - - - - - - - - - - - - - - - -
- - - -

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

- - - - -
- -
-

Digesters process the tag/text pairs found in a -comment block. They are looked up by tag name. -The digester gets the tagname, the value, the -target object to apply values to, and the full -block that is being processed. Digesters can -be declared as strings instead of a function -- -in that case, the program will try to look up -the key listed and use the function there instead -(it is an alias). Digesters can return a host -object in the case the tag defines a new key -block type (modules/classes/methods/events/properties)

- -
- - - - -
-

Fires event digestersChange

- -

- Fires when the value for the configuration attribute digesters is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +

    digesters

    + + + + + + + + + +
    +

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

    + +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - -
- -

dirmap

- - - - - - - - - - - - - - - - -
- - - -

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

- - - - -
- -
-

A map of file names to directory name. Provided in -case this needs to be used to reset the module name -appropriately -- currently not used

- -
- - - - -
-

Fires event dirmapChange

- -

- Fires when the value for the configuration attribute dirmap is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +
    +

    Digesters process the tag/text pairs found in a + comment block. They are looked up by tag name. + The digester gets the tagname, the value, the + target object to apply values to, and the full + block that is being processed. Digesters can + be declared as strings instead of a function -- + in that case, the program will try to look up + the key listed and use the function there instead + (it is an alias). Digesters can return a host + object in the case the tag defines a new key + block type (modules/classes/methods/events/properties)

    +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - + + +
+

Fires event digestersChange

+ +

+ Fires when the value for the configuration attribute digesters is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ + +
+ +

dirmap

+ + + + + + + + + +
+

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

+ + +
+ +
+

A map of file names to directory name. Provided in + case this needs to be used to reset the module name + appropriately -- currently not used

+ +
+ + +
+

Fires event dirmapChange

+ +

+ Fires when the value for the configuration attribute dirmap is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ +
- -

emitters

- - - - - - - - - - - - - - - - -
- - - -

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

- - - - -
- -
-

Emitters will be schemas for the types of payloads -the parser will emit. Not implemented.

- -
- - - - -
-

Fires event emittersChange

- -

- Fires when the value for the configuration attribute emitters is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +

    emitters

    + + + + + + + + + +
    +

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

    + +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - + +
+

Emitters will be schemas for the types of payloads + the parser will emit. Not implemented.

+ +
+ + +
+

Fires event emittersChange

+ +

+ Fires when the value for the configuration attribute emitters is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ +
- -

filemap

- - - - - - - - - - - - - - - - -
- - - -

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

- - - - -
- -
-

The map of file names to file content.

- -
- - - - -
-

Fires event filemapChange

- -

- Fires when the value for the configuration attribute filemap is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +

    filemap

    + + + + + + + + + +
    +

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

    + +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - + +
+

The map of file names to file content.

+ +
+ + +
+

Fires event filemapChange

+ +

+ Fires when the value for the configuration attribute filemap is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ +
- -

initialized

- Boolean - - - - - - - - - - - - - - - readonly - - -
- - -

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

- - - - -
- -
-

Flag indicating whether or not this object -has been through the init lifecycle phase.

- -
- - -

Default: false

- - - -
-

Fires event initializedChange

- -

- Fires when the value for the configuration attribute initialized is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +

    initialized

    + Boolean + + + + + + + + readonly + +
    +

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

    + +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - -
- -

mainmodule

- String - - - - - - - - - - - - - - - -
- - - -

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

- - - - -
- -
-

The main documentation block for the module itself.

- -
- - - - -
-

Fires event mainmoduleChange

- -

- Fires when the value for the configuration attribute mainmodule is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +
    +

    Flag indicating whether or not this object + has been through the init lifecycle phase.

    +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - + +

Default: false

+ +
+

Fires event initializedChange

+ +

+ Fires when the value for the configuration attribute initialized is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ + +
+ +

mainmodule

+ String + + + + + + + + +
+

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

+ + +
+ +
+

The main documentation block for the module itself.

+ +
+ + +
+

Fires event mainmoduleChange

+ +

+ Fires when the value for the configuration attribute mainmodule is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ +
- -

syntaxtype

- String - - - - - - - - - - - - - - - -
- - - -

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

- - - - -
- -
-

Comment syntax type.

- -
- - - - -
-

Fires event syntaxtypeChange

- -

- Fires when the value for the configuration attribute syntaxtype is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

- -
-

Parameters:

- -
    -
  • - e - EventFacade - -
    - An Event Facade object with the following - attribute-specific properties added: + +

    syntaxtype

    + String + + + + + + + + +
    +

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

    + +
    - -
      -
    • - prevVal - Any -
      The value of the attribute, prior to it being set.
      -
      • -
    • - newVal - Any -
      The value the attribute is to be set to.
      -
      • -
    • - attrName - String -
      The name of the attribute being set.
      -
      • -
    • - subAttrName - String -
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      -
      • -
    -
    • -
-
-
- - - -
- - + +
+

Comment syntax type.

+ +
+ + +
+

Fires event syntaxtypeChange

+ +

+ Fires when the value for the configuration attribute syntaxtype is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

+ +
+

Parameters:

+ +
    +
  • + e + EventFacade + +
    + An Event Facade object with the following + attribute-specific properties added: +
    + +
      +
    • + prevVal + Any +
      The value of the attribute, prior to it being set.
      +
      • +
    • + newVal + Any +
      The value the attribute is to be set to.
      +
      • +
    • + attrName + String +
      The name of the attribute being set.
      +
      • +
    • + subAttrName + String +
      If setting a property within the attribute's value, the name of the sub-attribute property being set.
      +
      • +
    +
    • +
+
+
+ + - -

Events

-
-

destroy

- - - - - - - - - - -
- - -

Inherited from - BaseObservable: - - - - base/js/BaseObservable.js:163 - -

- - - - -
- -
-

-Lifecycle event for the destroy phase, -fired prior to destruction. Invoking the preventDefault -method on the event object provided to subscribers will -prevent destruction from proceeding. -

-

-Subscribers to the "after" moment of this event, will be notified -after destruction is complete (and as a result cannot prevent -destruction). -

-
- - -
-

Event Payload:

- -
    - -
  • +

    destroy

    + - e - EventFacade - - -
    -

    Event object

    - -
    - -
    • - -
-
- - - - -
- - -
-

init

- - - - - - - - - - -
- - -

Inherited from - BaseObservable: - - - - base/js/BaseObservable.js:62 - -

- - - - -
- -
-

-Lifecycle event for the init phase, fired prior to initialization. -Invoking the preventDefault() method on the event object provided -to subscribers will prevent initialization from occuring. -

-

-Subscribers to the "after" momemt of this event, will be notified -after initialization of the object is complete (and therefore -cannot prevent initialization). -

-
- - -
-

Event Payload:

- -
    - -
  • - e - EventFacade +
    +

    Inherited from + BaseObservable: + base/js/BaseObservable.js:163 +

    + + +
    + +
    +

    + Lifecycle event for the destroy phase, + fired prior to destruction. Invoking the preventDefault + method on the event object provided to subscribers will + prevent destruction from proceeding. +

    +

    + Subscribers to the "after" moment of this event, will be notified + after destruction is complete (and as a result cannot prevent + destruction). +

    +
    + +
    +

    Event Payload:

    + + +
    - - -
    -

    Event object, with a cfg property which -refers to the configuration object passed to the constructor.

    -
    - +
    +

    init

    + -
    • - -
-
- - - - -
- - + + + + +
+

Inherited from + BaseObservable: + base/js/BaseObservable.js:62 +

+ + +
+ +
+

+ Lifecycle event for the init phase, fired prior to initialization. + Invoking the preventDefault() method on the event object provided + to subscribers will prevent initialization from occuring. +

+

+ Subscribers to the "after" momemt of this event, will be notified + after initialization of the object is complete (and therefore + cannot prevent initialization). +

+
+ +
+

Event Payload:

+ +
    +
  • + e + EventFacade + + +
    +

    Event object, with a cfg property which + refers to the configuration object passed to the constructor.

    + +
    + +
    • +
+
+ + +
- - diff --git a/output/api/classes/DocView.html b/output/api/classes/DocView.html index 93a7ac6c..67cbe517 100644 --- a/output/api/classes/DocView.html +++ b/output/api/classes/DocView.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,318 +25,209 @@

- Show: - - - - - - - -
- - + Show: + + + + + + + +
+
-

DocView Class

+

DocView Class

- - -
Defined in: lib/docview.js:14
- - - Module: yuidoc - - -
-

View class borrowed from Selleck
The view class is a handlebars template helper.

-

Constructor

-

DocView

- - -
- (
    - -
  • - - data - -
    • - -
  • - - templateName - -
    • - -
) -
- - - - - - - - - - - - - - - - -
+

DocView

- - -

- - Defined in +

+ (
    +
  • + data +
    • +
  • + templateName +
    • +
) +
+ + + + + + + + +
+

+ Defined in + lib/docview.js:14 +

+ + + +
+ +
- +
+
+

Parameters:

- lib/docview.js:14 +
    +
  • + data + Object -

    - - - +
    +

    Meta data to use in this template

    + +
    + +
    • +
  • + templateName + String + + +
    +

    The name of the template file to render.

    + +
    + +
    • +
+
+ -
- -
-
- - -
-

Parameters:

- -
    - -
  • - - data - Object - - - - -
    -

    Meta data to use in this template

    - -
    - - -
    • - -
  • - - templateName - String - - - - -
    -

    The name of the template file to render.

    - -
    - - -
    • - -
- - - - - -
-
-

Item Index

-

Methods

- - - -
-

Methods

- -
+

htmlTitle

- () - - - - - - - -
- - -

- Defined in - - - - lib/docview.js:28 -

- -
@@ -346,54 +235,30 @@

htmlTitle

- - - -
- -
+
+

title

- () - - - - - - - -
- - -

- Defined in - - - - lib/docview.js:47 -

- -
@@ -401,25 +266,16 @@

title

- - - -
- +
- - - -
-
diff --git a/output/api/classes/Files.html b/output/api/classes/Files.html index c87c9b21..56117a13 100644 --- a/output/api/classes/Files.html +++ b/output/api/classes/Files.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,303 +25,194 @@

- Show: - - - - - - - -
- - + Show: + + + + + + + +
+
-

Files Class

+

Files Class

- - -
- Defined in: lib/files.js:3 + Defined in: lib/files.js:8
- - - Module: yuidoc - - -
-

Ported fileutils methods from Selleck

-

Item Index

-

Methods

- - - -
-

Methods

- -
+

copyAssets

-
(
    -
  • - from -
    • -
  • - dest -
    • -
  • - deleteFirst -
    • -
  • - callback -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/files.js:363 - + lib/files.js:368

- -
@@ -331,154 +220,95 @@

copyAssets

-

Parameters:

    -
  • - from Path - -

    The source directory

    -
    • -
  • - dest Path - -

    The destination directory

    -
    • -
  • - deleteFirst Boolean - -

    Should the directory be deleted if it exists

    -
    • -
  • - callback Function - -

    The callback to be executed

    -
    • -
- - - -
- -
+
+

copyDirectory

-
(
    -
  • - source -
    • -
  • - dest -
    • -
  • - [overwrite=false] -
    • -
  • - callback -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/files.js:32 - + lib/files.js:37

- -
@@ -486,52 +316,37 @@

copyDirectory

-

Parameters:

    -
  • - source Path - -

    The source directory

    -
    • -
  • - dest Path - -

    The destination directory

    -
    • -
  • - [overwrite=false] Boolean optional - -

    Whether or not to overwrite destination files @@ -539,103 +354,59 @@

    Parameters:

    -
    • -
  • - callback Function - -

    The callback to be executed when complete.

    -
    • -
- - - -
- -
+
+

copyFile

-
(
    -
  • - source -
    • -
  • - dest -
    • -
  • - [overwrite=false] -
    • -
  • - callback -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/files.js:122 - + lib/files.js:127

- -
@@ -643,52 +414,37 @@

copyFile

-

Parameters:

    -
  • - source Path - -

    The source file

    -
    • -
  • - dest Path - -

    The destination file

    -
    • -
  • - [overwrite=false] Boolean optional - -

    Whether or not to overwrite destination files @@ -696,121 +452,71 @@

    Parameters:

    -
    • -
  • - callback Callback - -

    The callback to be executed when complete.

    -
      -
    • - err Error -

      The Error returned from Node

      -
      • -
    -
    • -
- - - -
- -
+
+

copyPath

-
(
    -
  • - source -
    • -
  • - dest -
    • -
  • - [overwrite=false] -
    • -
  • - callback -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/files.js:175 - + lib/files.js:180

- -
@@ -827,52 +533,37 @@

copyPath

-

Parameters:

    -
  • - source String - -

    Source path.

    -
    • -
  • - dest String - -

    Destination path.

    -
    • -
  • - [overwrite=false] Boolean optional - -

    Whether or not to overwrite destination files @@ -880,102 +571,61 @@

    Parameters:

    -
    • -
  • - callback Callback - -

    The callback to execute when completed.

    - -
    • -
- - - -
- -
+
+

deletePath

-
(
    -
  • - path -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/files.js:221 - + lib/files.js:226

- -
@@ -985,92 +635,56 @@

deletePath

-

Parameters:

    -
  • - path String - -

    File or directory to delete.

    -
    • -
- - - -
- -
+
+

getJSON

-
(
    -
  • - filename -
    • -
)
- - Object - - - - - - -
- - -

- Defined in - - - - - lib/files.js:411 - + lib/files.js:416

- -
@@ -1078,112 +692,68 @@

getJSON

-

Parameters:

    -
  • - filename Path - -

    The filename to parse JSON from

    -
    • -
- -

Returns:

- - Object: -

The JSON data

-
- - -
- -
+
+

isDirectory

-
(
    -
  • - path -
    • -
  • - [link=false] -
    • -
)
- - Boolean - - - - - - -
- - -

- Defined in - - - - - lib/files.js:246 - + lib/files.js:251

- -
@@ -1191,129 +761,80 @@

isDirectory

-

Parameters:

    -
  • - path Path - -

    The path to check

    -
    • -
  • - [link=false] Boolean optional - -

    Also validate a symlink

    -
    • -
- -

Returns:

- - Boolean: -

True if it is a directory

-
- - -
- -
+
+

isFile

-
(
    -
  • - path -
    • -
  • - [link=false] -
    • -
)
- - Boolean - - - - - - -
- - -

- Defined in - - - - - lib/files.js:277 - + lib/files.js:282

- -
@@ -1321,123 +842,77 @@

isFile

-

Parameters:

    -
  • - path Path - -

    The path to check

    -
    • -
  • - [link=false] Boolean optional - -

    Also validate a symlink

    -
    • -
- -

Returns:

- - Boolean: -

True if it is a file

-
- - -
- - + - -
+
+

lstatSync

-
(
    -
  • - path -
    • -
)
- - fs.Stats | Null - - - - - - -
- - -

- Defined in - - - - - lib/files.js:320 - + lib/files.js:325

- -
@@ -1553,106 +987,65 @@

lstatSync

-

Parameters:

    -
  • - path String - -

    Path to stat.

    -
    • -
- -

Returns:

- - fs.Stats | Null: -

fs.Stats object, or null if path doesn't exist.

-
- - -
- -
+
+

statSync

-
(
    -
  • - path -
    • -
)
- - fs.Stats | Null - - - - - - -
- - -

- Defined in - - - - - lib/files.js:342 - + lib/files.js:347

- -
@@ -1661,114 +1054,68 @@

statSync

-

Parameters:

    -
  • - path String - -

    Path to stat.

    -
    • -
- -

Returns:

- - fs.Stats | Null: -

fs.Stats object, or null if path doesn't exist.

-
- - -
- -
+
+

writeFile

-
(
    -
  • - file -
    • -
  • - data -
    • -
  • - callback -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/files.js:426 - + lib/files.js:431

- -
@@ -1776,82 +1123,55 @@

writeFile

-

Parameters:

    -
  • - file Path - -

    The filename to write to

    -
    • -
  • - data String - -

    The data to write

    -
    • -
  • - callback Callback - - multiple -
    -
    • -
- - - -
- +
- - - -
-
diff --git a/output/api/classes/Help.html b/output/api/classes/Help.html index daba6186..377f583e 100644 --- a/output/api/classes/Help.html +++ b/output/api/classes/Help.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,226 +25,153 @@

-
-
- -
-
-
-
- Show: - - - - - - - -
- -
-

Help Class

+

Help Class

- - -
Defined in: lib/help.js:8
- - - Module: yuidoc - - -
-

Shows the help text

-

Item Index

-

Methods

- -

Properties

- - -
-

Methods

- -
+

renderHelp

- () - - String - - - - - - -
- - -

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

- -
@@ -254,68 +179,39 @@

renderHelp

- -

Returns:

- - String: -

The help screen to display

-
- - -
- -
+
+

showHelp

- () - - - - - - - -
- - -

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

- -
@@ -323,78 +219,46 @@

showHelp

- - - -
- +
- -

Properties

-
-

help

- Array - - - - - private - - - - - - -
- - - -

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

- - - - -
- -
-

The help text to display

- -
- - - - - - -
- - +

help

+ Array + + + private + + + +
+

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

+ + +
+ +
+

The help text to display

+ +
+ + + +
- - -
-
diff --git a/output/api/classes/Main.html b/output/api/classes/Main.html index 1b5cc05c..c7bf8736 100644 --- a/output/api/classes/Main.html +++ b/output/api/classes/Main.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,106 +25,80 @@

- Show: - - - - - - - -
- - + Show: + + + + + + + +
+
-

Main Class

+

Main Class

- - -
Defined in: lib/index.js:7
- - - Module: yuidoc - - -
-

Module creates the YUI instance with the required modules, uses them and exports the Y to be used by the CLI class or by extenders: require('yuidocjs');
You can use it like this:

@@ -141,40 +113,26 @@

Main Class

-

Item Index

- - - -
- - - -
-
diff --git a/output/api/classes/Options.html b/output/api/classes/Options.html index 8d7d5edc..4bf43de7 100644 --- a/output/api/classes/Options.html +++ b/output/api/classes/Options.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,212 +25,144 @@

- Show: - - - - - - - -
- - + Show: + + + + + + + +
+
-

Options Class

+

Options Class

- - -
- Defined in: lib/options.js:5 + Defined in: lib/options.js:10
- - - Module: yuidoc - - -
-

Handles argument parsing

-

Item Index

-

Methods

- - - -
-

Methods

- -
+

Options

-
(
    -
  • - args -
    • -
)
- - Object - - - - - - -
- - -

- Defined in - - - - - lib/options.js:11 - + lib/options.js:16

- -
@@ -240,63 +170,42 @@

Options

-

Parameters:

    -
  • - args Array - -

    Arguments to parse

    -
    • -
- -

Returns:

- - Object: -

The config object

-
- - -
- +
- - - -
-
diff --git a/output/api/classes/Server.html b/output/api/classes/Server.html index af450ce5..08f5c406 100644 --- a/output/api/classes/Server.html +++ b/output/api/classes/Server.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,280 +25,183 @@

- Show: - - - - - - - -
- - + Show: + + + + + + + +
+
-

Server Class

+

Server Class

- - -
- Defined in: lib/server.js:4 + Defined in: lib/server.js:9
- - - Module: yuidoc - - -
-

Provides the --server server option for YUIDoc

-

Item Index

-

Methods

- -

Properties

- - -
-

Methods

- -
+

clazz

-
(
    -
  • - req -
    • -
  • - res -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/server.js:131 - + lib/server.js:136

- -
@@ -308,110 +209,67 @@

clazz

-

Parameters:

    -
  • - req Request - -

    Express request object

    -
    • -
  • - res Response - -

    Express response object

    -
    • -
- - - -
- -
+
+

files

-
(
    -
  • - req -
    • -
  • - res -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/server.js:105 - + lib/server.js:110

- -
@@ -419,110 +277,67 @@

files

-

Parameters:

    -
  • - req Request - -

    Express request object

    -
    • -
  • - res Response - -

    Express response object

    -
    • -
- - - -
- -
+
+

home

-
(
    -
  • - req -
    • -
  • - res -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/server.js:163 - + lib/server.js:168

- -
@@ -530,94 +345,58 @@

home

-

Parameters:

    -
  • - req Request - -

    Express request object

    -
    • -
  • - res Response - -

    Express response object

    -
    • -
- - - -
- -
+
+

init

- () - - - - - - - -
- - -

- Defined in - - - - - lib/server.js:175 - + lib/server.js:180

- -
@@ -625,70 +404,39 @@

init

- - - -
- -
+
+

modules

-
(
    -
  • - req -
    • -
  • - res -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/server.js:147 - + lib/server.js:152

- -
@@ -696,116 +444,70 @@

modules

-

Parameters:

    -
  • - req Request - -

    Express request object

    -
    • -
  • - res Response - -

    Express response object

    -
    • -
- - - -
- -
+
+

parse

-
(
    -
  • - req -
    • -
  • - res -
    • -
  • - next -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/server.js:17 - + lib/server.js:22

- -
@@ -813,110 +515,69 @@

parse

-

Parameters:

    -
  • - req Request - -

    Express request object

    -
    • -
  • - res Response - -

    Express response object

    -
    • -
  • - next Function - -

    Express next callback

    -
    • -
- - - -
- -
+
+

routes

- () - - - - - - - -
- - -

- Defined in - - - - - lib/server.js:35 - + lib/server.js:40

- -
@@ -924,64 +585,36 @@

routes

- - - -
- -
+
+

start

-
(
    -
  • - options -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - - lib/server.js:193 - + lib/server.js:198

- -
@@ -989,102 +622,63 @@

start

-

Parameters:

    -
  • - options Object - -

    Server options

    -
    • -
- - - -
- +
- -

Properties

-
-

_externalData

- Object - - - - - private - - - - - - -
- - - -

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

- - - - -
- -
-

Cache for external mixed in data.

- -
- - - - - - -
- - +

_externalData

+ Object + + + private + + + +
+

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

+ + +
+ +
+

Cache for external mixed in data.

+ +
+ + + +
- - -
-
diff --git a/output/api/classes/Utils.html b/output/api/classes/Utils.html index 68e7a809..8037d11c 100644 --- a/output/api/classes/Utils.html +++ b/output/api/classes/Utils.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,289 +25,188 @@

- Show: - - - - - - - -
- - + Show: + + + + + + + +
+
-

Utils Class

+

Utils Class

- - -
Defined in: lib/utils.js:11
- - - Module: yuidoc - - -
-

Utilities Class

-

Item Index

-

Methods

- - - -
-

Methods

- -
+

escapeHTML

-
(
    -
  • - html -
    • -
)
- - String - - - - - - -
- - -

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

- -
@@ -317,106 +214,65 @@

escapeHTML

-

Parameters:

    -
  • - html String - -

    String to escape.

    -
    • -
- -

Returns:

- - String: -

Escaped string.

-
- - -
- -
+
+

fixType

-
(
    -
  • - t -
    • -
)
- - String - - - - - - -
- - -

- Defined in - - - - lib/utils.js:454 -

- -
@@ -424,106 +280,65 @@

fixType

-

Parameters:

    -
  • - t String - -

    The type string to convert

    -
    • -
- -

Returns:

- - String: -

The fixed string

-
- - -
- -
+
+

getDirs

-
(
    -
  • - dir -
    • -
)
- - Array - - - - - - -
- - -

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

- -
@@ -531,106 +346,65 @@

getDirs

-

Parameters:

    -
  • - dir String - -

    The dir to begin at

    -
    • -
- -

Returns:

- - Array: -

The array of directories..

-
- - -
- -
+
+

getLayouts

-
(
    -
  • - dir -
    • -
)
- - Object - - - - - - -
- - -

- Defined in - - - - lib/utils.js:65 -

- -
@@ -639,106 +413,65 @@

getLayouts

-

Parameters:

    -
  • - dir String - -

    Directory path.

    -
    • -
- -

Returns:

- - Object: -

Mapping of layout names to layout content.

-
- - -
- -
+
+

getPage

-
(
    -
  • - pagePath -
    • -
)
- - String | Null - - - - - - -
- - -

- Defined in - - - - lib/utils.js:78 -

- -
@@ -746,106 +479,65 @@

getPage

-

Parameters:

    -
  • - pagePath String - -

    Path to a single .handlebars page.

    -
    • -
- -

Returns:

- - String | Null: -

Page content, or null if not found.

-
- - -
- -
+
+

getPages

-
(
    -
  • - dir -
    • -
)
- - Object - - - - - - -
- - -

- Defined in - - - - lib/utils.js:93 -

- -
@@ -855,106 +547,65 @@

getPages

-

Parameters:

    -
  • - dir String - -

    Directory path.

    -
    • -
- -

Returns:

- - Object: -

Mapping of page names to page content.

-
- - -
- -
+
+

getPartials

-
(
    -
  • - dir -
    • -
)
- - Object - - - - - - -
- - -

- Defined in - - - - lib/utils.js:126 -

- -
@@ -963,102 +614,62 @@

getPartials

-

Parameters:

    -
  • - dir String - -

    Directory path.

    -
    • -
- -

Returns:

- - Object: -

Mapping of partial names to partial content.

-
- - -
- -
+
+

getProjectData

-
(
    -
  • - [dir=process.cwd()] -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - lib/utils.js:226 -

- -
@@ -1066,101 +677,60 @@

getProjectData

-

Parameters:

    -
  • - [dir=process.cwd()] Path optional - -

    The directory to start from

    -
    • -
- - - -
- -
+
+

prepare

-
(
    -
  • - inDir -
    • -
  • - options -
    • -
  • - callback -
    • -
)
- - - - - - - -
- - -

- Defined in - - - - lib/utils.js:140 -

- -
@@ -1168,157 +738,100 @@

prepare

-

Parameters:

    -
  • - inDir String - -

    The starting directory

    -
    • -
  • - options Object - -

    The options for the meta data.

    -
    • -
  • - callback Callback - -

    The callback to excecute when complete

    -
      -
    • - err Error -
      -
      • -
    • - options Object -

      Merged options.

      -
      • -
    -
    • -
- - - -
- -
+
+

unindent

-
(
    -
  • - content -
    • -
)
- - String - - - private - - - - -
- - -

- Defined in - - - - lib/utils.js:44 -

- -
@@ -1329,108 +842,65 @@

unindent

-

Parameters:

    -
  • - content String - -

    Text to unindent.

    -
    • -
- -

Returns:

- - String: -

Unindented text.

-
- - -
- -
+
+

validatePaths

-
(
    -
  • - paths -
    • -
  • - [ignore=false] -
    • -
)
- - - - - - - -
- - -

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

- -
@@ -1438,109 +908,68 @@

validatePaths

-

Parameters:

    -
  • - paths Array - -

    The array of paths to validate

    -
    • -
  • - [ignore=false] String optional - -

    A string to call .indexOf on a path to determine if it should be ignored

    -
    • -
- - - -
- -
+
+

webpath

-
(
    -
  • - url -
    • -
)
- - String - - - - - - -
- - -

- Defined in - - - - lib/utils.js:476 -

- -
@@ -1551,63 +980,42 @@

webpath

-

Parameters:

    -
  • - url Array | String* - -

    the list of parts to be joined and normalized

    -
    • -
- -

Returns:

- - String: -

The joined and normalized url

-
- - -
- +
- - - -
-
diff --git a/output/api/classes/YUIDoc.html b/output/api/classes/YUIDoc.html index ee2c3710..ad735c91 100644 --- a/output/api/classes/YUIDoc.html +++ b/output/api/classes/YUIDoc.html @@ -6,7 +6,7 @@ - + @@ -14,12 +14,10 @@
- -

- +

- API Docs for: 0.4.0 + API Docs for: 0.5.0
@@ -27,106 +25,80 @@

- Show: - - - - - - - -
- - + Show: + + + + + + + +
+
-

YUIDoc Class

+

YUIDoc Class

- - -
Defined in: lib/yuidoc.js:49
- - - Module: yuidoc - - -
-

YUIDoc main class

   var options = {
@@ -139,301 +111,180 @@ 
YUIDoc Class
-

Constructor

-

YUIDoc

- - -
- (
    - -
  • - - config - -
    • - -
) -
- - - - - - - - - - - - - - - - -
+

YUIDoc

+ +
+ (
    +
  • + config +
    • +
) +
- - -

- - Defined in + + + + + + + +

+

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

+ + + +
+ +
- +
+
+

Parameters:

- lib/yuidoc.js:49 +
    +
  • + config + Object -

    - - - +
    +

    The config object

    + +
    + +
    • +
+
+ -
- -
-
- - -
-

Parameters:

- -
    - -
  • - - config - Object - - - - -
    -

    The config object

    - -
    - - -
    • - -
- - - - - -
-
-

Item Index

-

Methods

- -

Properties

- - -
-

Methods

- -
+

_processConfig

- () - - - - private - - - - -
- - -

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

- -
@@ -441,56 +292,31 @@

_processConfig

- - - -
- -
+
+

_setDefaultExcludes

- () - - - - private - - - - -
- - -

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

- -
@@ -498,66 +324,37 @@

_setDefaultExcludes

- - - -
- -
+
+

parsedir

-
(
    -
  • - dir -
    • -
)
- - - - private - - - - -
- - -

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

- -
@@ -565,96 +362,57 @@

parsedir

-

Parameters:

    -
  • - dir String - -

    The directory to parse the contents of.

    -
    • -
- - - -
- -
+
+

parsefiles

-
(
    -
  • - dir -
    • -
  • - files -
    • -
)
- - - - private - - - - -
- - -

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

- -
@@ -662,98 +420,61 @@

parsefiles

-

Parameters:

    -
  • - dir String - -

    The directory to start from.

    -
    • -
  • - files Array - -

    List of files to parse.

    -
    • -
- - - -
- -
+
+

run

- () - - Object - - - - - - -
- - -

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

- -
@@ -761,74 +482,43 @@

run

- -

Returns:

- - Object: -

The JSON data returned from the DocParser

-
- - -
- -
+
+

runPreprocessors

- () - - Object - - - private - - - - -
- - -

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

- -
@@ -837,70 +527,40 @@

runPreprocessors

- -

Returns:

- - Object: -

The mutated data

-
- - -
- -
+
+

walk

- () - - - - private - - - - -
- - -

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

- -
@@ -908,70 +568,40 @@

walk

- - - -
- -
+
+

writeJSON

-
(
    -
  • - parser -
    • -
)
- - Object - - - private - - - - -
- - -

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

- -
@@ -980,441 +610,252 @@

writeJSON

-

Parameters:

    -
  • - parser Object - -

    The DocParser instance to use

    -
    • -
- -

Returns:

- - Object: -

The JSON data returned from the DocParser

-
- - -
- +
- -

Properties

-
-

dirmap

- Object - - - - - private - - - - - - -
- - - -

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

- - - - -
- -
-

Holder for the list of directories we are processing.

- -
- - - - - - -
- - +

dirmap

+ Object + + + private + + + +
+

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

+ + +
+ +
+

Holder for the list of directories we are processing.

+ +
+ + + +
-

endtime

- Timestamp - - - - - - - - - -
- - - -

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

- - - - -
- -
-

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

- -
- - - - - - -
- - +

endtime

+ Timestamp + + + + + +
+

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

+ + +
+ +
+

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

+ +
+ + + +
-

filecount

- Boolean - - - - - private - - - - - - -
- - - -

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

- - - - -
- -
-

Holds the number of files that we are processing.

- -
- - - - - - -
- - +

filecount

+ Boolean + + + private + + + +
+

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

+ + +
+ +
+

Holds the number of files that we are processing.

+ +
+ + + +
-

filemap

- Object - - - - - private - - - - - - -
- - - -

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

- - - - -
- -
-

Holder for the list of files we are processing.

- -
- - - - - - -
- - +

filemap

+ Object + + + private + + + +
+

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

+ + +
+ +
+

Holder for the list of files we are processing.

+ +
+ + + +
-

OPTIONS

- Object - - - - - - - final - - - - -
- - - -

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

- - - - -
- -
-

The default list of configuration options

- -
- - - - - - -
- - +

OPTIONS

+ Object + + + + final + + +
+

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

+ + +
+ +
+

The default list of configuration options

+ +
+ + + +
-

options

- Object - - - - - private - - - - - - -
- - - -

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

- - - - -
- -
-

Internal holder for configuration options.

- -
- - - - - - -
- - +

options

+ Object + + + private + + + +
+

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

+ + +
+ +
+

Internal holder for configuration options.

+ +
+ + + +
-

selleck

- Object - - - - - private - - - - - - -
- - - -

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

- - - - -
- -
-

Hash map of dirnames to selleck config options.

- -
- - - - - - -
- - +

selleck

+ Object + + + private + + + +
+

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

+ + +
+ +
+

Hash map of dirnames to selleck config options.

+ +
+ + + +
-

starttime

- Timestamp - - - - - - - - - -
- - - -

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

- - - - -
- -
-

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

- -
- - - - - - -
- - +

starttime

+ Timestamp + + + + + +
+

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

+ + +
+ +
+

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

+ +
+ + + +
- - -
- diff --git a/output/api/data.json b/output/api/data.json index 2de8fa14..0824035f 100644 --- a/output/api/data.json +++ b/output/api/data.json @@ -1,9 +1,8 @@ { "project": { "name": "yuidoc-root", - "logo": "http://yuilibrary.com/img/yui-logo.png", "description": "YUIDoc, YUI's JavaScript Documentation engine.", - "version": "0.4.0" + "version": "0.5.0" }, "files": { "lib/builder.js": { @@ -80,6 +79,13 @@ "fors": {}, "namespaces": {} }, + "lib/project.js": { + "name": "lib/project.js", + "modules": {}, + "classes": {}, + "fors": {}, + "namespaces": {} + }, "lib/server.js": { "name": "lib/server.js", "modules": {}, @@ -180,7 +186,7 @@ "module": "yuidoc", "namespace": "", "file": "lib/docparser.js", - "line": 735, + "line": 737, "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, @@ -230,7 +236,7 @@ "module": "yuidoc", "namespace": "", "file": "lib/files.js", - "line": 3, + "line": 8, "description": "Ported fileutils methods from [Selleck](http://github.com/rgrove/selleck)" }, "Help": { @@ -273,7 +279,7 @@ "module": "yuidoc", "namespace": "", "file": "lib/options.js", - "line": 5, + "line": 10, "description": "Handles argument parsing" }, "Server": { @@ -287,7 +293,7 @@ "module": "yuidoc", "namespace": "", "file": "lib/server.js", - "line": 4, + "line": 9, "description": "Provides the `--server` server option for YUIDoc" }, "Utils": { @@ -331,6 +337,12 @@ } }, "classitems": [ + { + "file": "lib/builder.js", + "line": 1, + "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE", + "class": "DocBuilder" + }, { "file": "lib/builder.js", "line": 120, @@ -597,7 +609,7 @@ }, { "file": "lib/builder.js", - "line": 712, + "line": 707, "description": "Makes the default directories needed", "itemtype": "method", "name": "makeDirs", @@ -613,7 +625,7 @@ }, { "file": "lib/builder.js", - "line": 765, + "line": 760, "description": "Parses `
` tags and adds the __prettyprint__ `className` to them",
             "itemtype": "method",
             "name": "_parseCode",
@@ -635,7 +647,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 778,
+            "line": 773,
             "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 +669,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 797,
+            "line": 792,
             "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 +721,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 853,
+            "line": 848,
             "description": "Render the index file",
             "itemtype": "method",
             "name": "renderIndex",
@@ -723,13 +735,13 @@
                             "name": "html",
                             "description": "The HTML to render this view",
                             "type": "String"
+                        },
+                        {
+                            "name": "view",
+                            "description": "The View Data",
+                            "type": "Object"
                         }
                     ]
-                },
-                {
-                    "name": "cv.view",
-                    "description": "The View Data",
-                    "type": "Object"
                 }
             ],
             "class": "DocBuilder",
@@ -737,7 +749,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 878,
+            "line": 873,
             "description": "Generates the index.html file",
             "itemtype": "method",
             "name": "writeIndex",
@@ -745,7 +757,19 @@
                 {
                     "name": "cb",
                     "description": "The callback to execute after it's completed",
-                    "type": "Callback"
+                    "type": "Callback",
+                    "props": [
+                        {
+                            "name": "html",
+                            "description": "The HTML to write index view",
+                            "type": "String"
+                        },
+                        {
+                            "name": "view",
+                            "description": "The View Data",
+                            "type": "Object"
+                        }
+                    ]
                 }
             ],
             "class": "DocBuilder",
@@ -753,7 +777,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 902,
+            "line": 899,
             "description": "Render a module",
             "itemtype": "method",
             "name": "renderModule",
@@ -767,13 +791,13 @@
                             "name": "html",
                             "description": "The HTML to render this view",
                             "type": "String"
+                        },
+                        {
+                            "name": "view",
+                            "description": "The View Data",
+                            "type": "Object"
                         }
                     ]
-                },
-                {
-                    "name": "cv.view",
-                    "description": "The View Data",
-                    "type": "Object"
                 }
             ],
             "class": "DocBuilder",
@@ -781,7 +805,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 986,
+            "line": 983,
             "description": "Generates the module files under \"out\"/modules/",
             "itemtype": "method",
             "name": "writeModules",
@@ -789,7 +813,19 @@
                 {
                     "name": "cb",
                     "description": "The callback to execute after it's completed",
-                    "type": "Callback"
+                    "type": "Callback",
+                    "props": [
+                        {
+                            "name": "html",
+                            "description": "The HTML to write module view",
+                            "type": "String"
+                        },
+                        {
+                            "name": "view",
+                            "description": "The View Data",
+                            "type": "Object"
+                        }
+                    ]
                 }
             ],
             "class": "DocBuilder",
@@ -797,7 +833,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1027,
+            "line": 1026,
             "description": "Checks an array of items (class items) to see if an item is in that list",
             "itemtype": "method",
             "name": "hasProperty",
@@ -821,7 +857,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1044,
+            "line": 1043,
             "description": "Counter for stepping into merges",
             "access": "private",
             "tagname": "",
@@ -833,7 +869,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1051,
+            "line": 1050,
             "description": "Merge superclass data into a child class",
             "itemtype": "method",
             "name": "mergeExtends",
@@ -859,7 +895,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1103,
+            "line": 1102,
             "description": "Render the class file",
             "itemtype": "method",
             "name": "renderClass",
@@ -873,13 +909,13 @@
                             "name": "html",
                             "description": "The HTML to render this view",
                             "type": "String"
+                        },
+                        {
+                            "name": "view",
+                            "description": "The View Data",
+                            "type": "Object"
                         }
                     ]
-                },
-                {
-                    "name": "cv.view",
-                    "description": "The View Data",
-                    "type": "Object"
                 }
             ],
             "class": "DocBuilder",
@@ -887,7 +923,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1391,
+            "line": 1390,
             "description": "Generates the class files under \"out\"/classes/",
             "itemtype": "method",
             "name": "writeClasses",
@@ -895,7 +931,19 @@
                 {
                     "name": "cb",
                     "description": "The callback to execute after it's completed",
-                    "type": "Callback"
+                    "type": "Callback",
+                    "props": [
+                        {
+                            "name": "html",
+                            "description": "The HTML to write class view",
+                            "type": "String"
+                        },
+                        {
+                            "name": "view",
+                            "description": "The View Data",
+                            "type": "Object"
+                        }
+                    ]
                 }
             ],
             "class": "DocBuilder",
@@ -903,7 +951,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1432,
+            "line": 1433,
             "description": "Sort method of array of objects with a property called __name__",
             "itemtype": "method",
             "name": "nameSort",
@@ -928,7 +976,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1455,
+            "line": 1456,
             "description": "Generates the syntax files under `\"out\"/files/`",
             "itemtype": "method",
             "name": "writeFiles",
@@ -936,7 +984,19 @@
                 {
                     "name": "cb",
                     "description": "The callback to execute after it's completed",
-                    "type": "Callback"
+                    "type": "Callback",
+                    "props": [
+                        {
+                            "name": "html",
+                            "description": "The HTML to write file view",
+                            "type": "String"
+                        },
+                        {
+                            "name": "view",
+                            "description": "The View Data",
+                            "type": "Object"
+                        }
+                    ]
                 }
             ],
             "class": "DocBuilder",
@@ -944,7 +1004,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1503,
+            "line": 1506,
             "description": "Render the source file",
             "itemtype": "method",
             "name": "renderFile",
@@ -958,13 +1018,13 @@
                             "name": "html",
                             "description": "The HTML to render this view",
                             "type": "String"
+                        },
+                        {
+                            "name": "view",
+                            "description": "The View Data",
+                            "type": "Object"
                         }
                     ]
-                },
-                {
-                    "name": "cv.view",
-                    "description": "The View Data",
-                    "type": "Object"
                 }
             ],
             "class": "DocBuilder",
@@ -972,7 +1032,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1557,
+            "line": 1560,
             "description": "Write the API meta data used for the AutoComplete widget",
             "itemtype": "method",
             "name": "writeAPIMeta",
@@ -989,15 +1049,22 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1570,
-            "description": "Render the API meta and return the Javascript",
+            "line": 1573,
+            "description": "Render the API meta and return the JavaScript",
             "itemtype": "method",
             "name": "renderAPIMeta",
             "params": [
                 {
                     "name": "cb",
                     "description": "The callback",
-                    "type": "Callback"
+                    "type": "Callback",
+                    "props": [
+                        {
+                            "name": "apijs",
+                            "description": "The JavaScript code to write API meta data",
+                            "type": "String"
+                        }
+                    ]
                 }
             ],
             "async": 1,
@@ -1006,7 +1073,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1602,
+            "line": 1606,
             "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 +1093,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1615,
+            "line": 1619,
             "description": "Compiles the templates from the meta-data provided by DocParser",
             "itemtype": "method",
             "name": "compile",
@@ -1040,6 +1107,20 @@
             "class": "DocBuilder",
             "module": "yuidoc"
         },
+        {
+            "file": "lib/cli.js",
+            "line": 3,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "CLI",
+            "module": "yuidoc"
+        },
+        {
+            "file": "lib/docparser.js",
+            "line": 1,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "DocParser",
+            "module": "yuidoc"
+        },
         {
             "file": "lib/docparser.js",
             "line": 11,
@@ -1141,7 +1222,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 763,
+            "line": 765,
             "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 +1231,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 785,
+            "line": 787,
             "description": "Emitters will be schemas for the types of payloads\nthe parser will emit.  Not implemented.",
             "itemtype": "attribute",
             "name": "emitters",
@@ -1159,7 +1240,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 796,
+            "line": 798,
             "description": "Comment syntax type.",
             "itemtype": "attribute",
             "name": "syntaxtype",
@@ -1169,7 +1250,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 805,
+            "line": 807,
             "description": "The map of file names to file content.",
             "itemtype": "attribute",
             "name": "filemap",
@@ -1178,7 +1259,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 813,
+            "line": 815,
             "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 +1268,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 823,
+            "line": 825,
             "description": "The file currently being parsed",
             "itemtype": "attribute",
             "name": "currentfile",
@@ -1197,7 +1278,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 844,
+            "line": 846,
             "description": "The main documentation block for the module itself.",
             "itemtype": "attribute",
             "name": "mainmodule",
@@ -1207,7 +1288,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 880,
+            "line": 882,
             "description": "The module currently being parsed",
             "itemtype": "attribute",
             "name": "currentmodule",
@@ -1217,7 +1298,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 939,
+            "line": 941,
             "description": "The submodule currently being parsed",
             "itemtype": "attribute",
             "name": "currentsubmodule",
@@ -1227,7 +1308,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 979,
+            "line": 981,
             "description": "The class currently being parsed",
             "itemtype": "attribute",
             "name": "currentclass",
@@ -1237,7 +1318,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1019,
+            "line": 1021,
             "description": "Takes a non-namespaced classname and resolves it to a namespace (to support `@for`)",
             "access": "private",
             "tagname": "",
@@ -1259,7 +1340,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1093,
+            "line": 1095,
             "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 +1362,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1114,
+            "line": 1116,
             "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 +1388,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1190,
+            "line": 1192,
             "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 +1413,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1245,
+            "line": 1247,
             "description": "Processes all the tags in a single comment block",
             "itemtype": "method",
             "name": "processblock",
@@ -1348,7 +1429,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1318,
+            "line": 1320,
             "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 +1449,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1432,
+            "line": 1434,
             "description": "Extracts and transforms the filemap provided to constructor",
             "itemtype": "method",
             "name": "parse",
@@ -1391,6 +1472,13 @@
             "class": "DocParser",
             "module": "yuidoc"
         },
+        {
+            "file": "lib/docview.js",
+            "line": 1,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "DocView",
+            "module": "yuidoc"
+        },
         {
             "file": "lib/docview.js",
             "line": 28,
@@ -1411,7 +1499,14 @@
         },
         {
             "file": "lib/files.js",
-            "line": 32,
+            "line": 1,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "Files",
+            "module": "yuidoc"
+        },
+        {
+            "file": "lib/files.js",
+            "line": 37,
             "description": "Copy a directory from one location to another",
             "itemtype": "method",
             "name": "copyDirectory",
@@ -1444,7 +1539,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 122,
+            "line": 127,
             "description": "Copy a file from one location to another",
             "itemtype": "method",
             "name": "copyFile",
@@ -1484,7 +1579,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 175,
+            "line": 180,
             "description": "If _source_ is a file, copies it to _dest_. If it's a directory, recursively\ncopies it and all files and directories it contains to _dest_.\n\nNote that when attempting to copy a file into a directory, you should specify\nthe full path to the new file (including the new filename). Otherwise, it will\nbe interpreted as an attempt to copy the _source_ file *over* the _dest_\ndirectory instead of *into* it.\n\nKnown issues:\n- Doesn't preserve ownership or permissions on copied files/directories.",
             "itemtype": "method",
             "name": "copyPath",
@@ -1524,7 +1619,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 221,
+            "line": 226,
             "description": "If _path_ is a file, deletes it. If _path_ is a directory, recursively deletes\nit and all files and directories it contains.\n\nThis method is synchronous.",
             "itemtype": "method",
             "name": "deletePath",
@@ -1540,7 +1635,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 246,
+            "line": 251,
             "description": "Check to see if this is a directory",
             "itemtype": "method",
             "name": "isDirectory",
@@ -1567,7 +1662,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 277,
+            "line": 282,
             "description": "Check to see if this is a File",
             "itemtype": "method",
             "name": "isFile",
@@ -1594,7 +1689,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 306,
+            "line": 311,
             "description": "Check to see if this is a SymLink",
             "itemtype": "method",
             "name": "isSymbolicLink",
@@ -1614,7 +1709,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 320,
+            "line": 325,
             "description": "Like `fs.lstatSync()`, but returns `null` instead of throwing when _path_\ndoesn't exist. Will still throw on other types of errors.",
             "itemtype": "method",
             "name": "lstatSync",
@@ -1634,7 +1729,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 342,
+            "line": 347,
             "description": "Like `fs.statSync()`, but returns `null` instead of throwing when _path_\ndoesn't exist. Will still throw on other types of errors.",
             "itemtype": "method",
             "name": "statSync",
@@ -1654,7 +1749,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 363,
+            "line": 368,
             "description": "Copy the theme assets directory",
             "itemtype": "method",
             "name": "copyAssets",
@@ -1685,7 +1780,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 411,
+            "line": 416,
             "description": "Helper method for getting JSON data from a local file",
             "itemtype": "method",
             "name": "getJSON",
@@ -1705,7 +1800,7 @@
         },
         {
             "file": "lib/files.js",
-            "line": 426,
+            "line": 431,
             "description": "Helper method for writing files to disk. It wraps the NodeJS file API",
             "itemtype": "method",
             "name": "writeFile",
@@ -1730,6 +1825,13 @@
             "class": "Files",
             "module": "yuidoc"
         },
+        {
+            "file": "lib/help.js",
+            "line": 1,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "Help",
+            "module": "yuidoc"
+        },
         {
             "file": "lib/help.js",
             "line": 14,
@@ -1764,9 +1866,23 @@
             "class": "Help",
             "module": "yuidoc"
         },
+        {
+            "file": "lib/index.js",
+            "line": 1,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "Main",
+            "module": "yuidoc"
+        },
         {
             "file": "lib/options.js",
-            "line": 11,
+            "line": 1,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "Options",
+            "module": "yuidoc"
+        },
+        {
+            "file": "lib/options.js",
+            "line": 16,
             "description": "Parses arguments and returns an Object of config options",
             "itemtype": "method",
             "name": "Options",
@@ -1784,9 +1900,23 @@
             "class": "Options",
             "module": "yuidoc"
         },
+        {
+            "file": "lib/project.js",
+            "line": 1,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "Server",
+            "module": "yuidoc"
+        },
         {
             "file": "lib/server.js",
-            "line": 10,
+            "line": 1,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "Server",
+            "module": "yuidoc"
+        },
+        {
+            "file": "lib/server.js",
+            "line": 15,
             "description": "Cache for external mixed in data.",
             "itemtype": "property",
             "name": "_externalData",
@@ -1798,7 +1928,7 @@
         },
         {
             "file": "lib/server.js",
-            "line": 17,
+            "line": 22,
             "description": "Middleware to parse the API docs per request",
             "itemtype": "method",
             "name": "parse",
@@ -1824,7 +1954,7 @@
         },
         {
             "file": "lib/server.js",
-            "line": 35,
+            "line": 40,
             "description": "Create the routes used to serve YUIDoc files dynamically",
             "itemtype": "method",
             "name": "routes",
@@ -1833,7 +1963,7 @@
         },
         {
             "file": "lib/server.js",
-            "line": 105,
+            "line": 110,
             "description": "`/files` endpoint",
             "itemtype": "method",
             "name": "files",
@@ -1854,7 +1984,7 @@
         },
         {
             "file": "lib/server.js",
-            "line": 131,
+            "line": 136,
             "description": "`/classes` endpoint",
             "itemtype": "method",
             "name": "clazz",
@@ -1875,7 +2005,7 @@
         },
         {
             "file": "lib/server.js",
-            "line": 147,
+            "line": 152,
             "description": "`/modules` endpoint",
             "itemtype": "method",
             "name": "modules",
@@ -1896,7 +2026,7 @@
         },
         {
             "file": "lib/server.js",
-            "line": 163,
+            "line": 168,
             "description": "`/` endpoint",
             "itemtype": "method",
             "name": "home",
@@ -1917,7 +2047,7 @@
         },
         {
             "file": "lib/server.js",
-            "line": 175,
+            "line": 180,
             "description": "Creates the Express server and prep's YUI for serving",
             "itemtype": "method",
             "name": "init",
@@ -1926,7 +2056,7 @@
         },
         {
             "file": "lib/server.js",
-            "line": 193,
+            "line": 198,
             "description": "Start the server with the supplied options.",
             "itemtype": "method",
             "name": "start",
@@ -1940,6 +2070,13 @@
             "class": "Server",
             "module": "yuidoc"
         },
+        {
+            "file": "lib/utils.js",
+            "line": 1,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "Utils",
+            "module": "yuidoc"
+        },
         {
             "file": "lib/utils.js",
             "line": 31,
@@ -2201,6 +2338,13 @@
             "class": "Utils",
             "module": "yuidoc"
         },
+        {
+            "file": "lib/yuidoc.js",
+            "line": 1,
+            "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "class": "YUIDoc",
+            "module": "yuidoc"
+        },
         {
             "file": "lib/yuidoc.js",
             "line": 29,
@@ -2421,6 +2565,54 @@
         {
             "message": "unknown tag: exports",
             "line": " lib/index.js:7"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/builder.js:1"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/cli.js:3"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/docparser.js:1"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/docview.js:1"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/files.js:1"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/help.js:1"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/index.js:1"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/options.js:1"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/project.js:1"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/server.js:1"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/utils.js:1"
+        },
+        {
+            "message": "Missing item type\nCopyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE",
+            "line": " lib/yuidoc.js:1"
         }
     ]
 }
\ No newline at end of file
diff --git a/output/api/files/lib_builder.js.html b/output/api/files/lib_builder.js.html
index 52e05ec2..2bc4451f 100644
--- a/output/api/files/lib_builder.js.html
+++ b/output/api/files/lib_builder.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,92 +25,76 @@ 

         

             
-    

-

-
-            

-        
-        

-                

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
             

                 

                     

-                        
File: lib/builder.js

+
File: lib/builder.js

 
 

     
-/*
-Copyright (c) 2011, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://yuilibrary.com/license/
-*/
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 var marked = require('marked'),
     fs = require('graceful-fs'),
     noop = function () {},
@@ -800,20 +782,15 @@ 
File: lib/builder.js

                     Y.each(i, function (v, k) {
                         if (k === 'final') {
                             o[k1][k] = true;
-                        }
-                        if (k === 'description' || k === 'example') {
-                            if (k1 === 'return') {
-                                o[k1][k] = self.markdown(v);
-                            } else if (v.forEach || (v instanceof Object)) {
+                        } else if (k === 'description' || k === 'example') {
+                            if (v.forEach || (v instanceof Object)) {
                                 o[k1][k] = self.augmentData(v);
                             } else {
-                                //o[k1][k] = markdown(v, true, self.defaultTags);
                                 o[k1][k] = self.markdown(v);
                             }
                         }
                     });
                 } else if (k1 === 'description' || k1 === 'example') {
-                    //o[k1] = markdown(i, true, self.defaultTags);
                     o[k1] = self.markdown(i);
                 }
             });
@@ -965,7 +942,7 @@ 
File: lib/builder.js

          * @method renderIndex
          * @param {Function} cb The callback fired when complete
          * @param {String} cb.html The HTML to render this view
-         * @param {Object} cv.view The View Data
+         * @param {Object} cb.view The View Data
          */
         renderIndex: function (cb) {
             var self = this;
@@ -989,6 +966,8 @@ 
File: lib/builder.js

          * Generates the index.html file
          * @method writeIndex
          * @param {Callback} cb The callback to execute after it's completed
+         * @param {String} cb.html The HTML to write index view
+         * @param {Object} cb.view The View Data
          */
         writeIndex: function (cb) {
             var self = this,
@@ -1014,7 +993,7 @@ 
File: lib/builder.js

          * @method renderModule
          * @param {Function} cb The callback fired when complete
          * @param {String} cb.html The HTML to render this view
-         * @param {Object} cv.view The View Data
+         * @param {Object} cb.view The View Data
          */
         renderModule: function (cb, data, layout) {
             var self = this;
@@ -1097,6 +1076,8 @@ 
File: lib/builder.js

          * Generates the module files under "out"/modules/
          * @method writeModules
          * @param {Callback} cb The callback to execute after it's completed
+         * @param {String} cb.html The HTML to write module view
+         * @param {Object} cb.view The View Data
          */
         writeModules: function (cb, layout) {
             layout = layout || 'main';
@@ -1215,7 +1196,7 @@ 
File: lib/builder.js

          * @method renderClass
          * @param {Function} cb The callback fired when complete
          * @param {String} cb.html The HTML to render this view
-         * @param {Object} cv.view The View Data
+         * @param {Object} cb.view The View Data
          */
         renderClass: function (cb, data, layout) {
             var self = this;
@@ -1502,6 +1483,8 @@ 
File: lib/builder.js

          * Generates the class files under "out"/classes/
          * @method writeClasses
          * @param {Callback} cb The callback to execute after it's completed
+         * @param {String} cb.html The HTML to write class view
+         * @param {Object} cb.view The View Data
          */
         writeClasses: function (cb, layout) {
             layout = layout || 'main';
@@ -1566,6 +1549,8 @@ 
File: lib/builder.js

          * Generates the syntax files under `"out"/files/`
          * @method writeFiles
          * @param {Callback} cb The callback to execute after it's completed
+         * @param {String} cb.html The HTML to write file view
+         * @param {Object} cb.view The View Data
          */
         writeFiles: function (cb, layout) {
             layout = layout || 'main';
@@ -1615,7 +1600,7 @@ 
File: lib/builder.js

          * @method renderFile
          * @param {Function} cb The callback fired when complete
          * @param {String} cb.html The HTML to render this view
-         * @param {Object} cv.view The View Data
+         * @param {Object} cb.view The View Data
          */
         renderFile: function (cb, data, layout) {
             var self = this;
@@ -1678,9 +1663,10 @@ 
File: lib/builder.js

             });
         },
         /**
-         * Render the API meta and return the Javascript
+         * Render the API meta and return the JavaScript
          * @method renderAPIMeta
          * @param {Callback} cb The callback
+         * @param {String} cb.apijs The JavaScript code to write API meta data
          * @async
          */
         renderAPIMeta: function (cb) {
@@ -1781,7 +1767,6 @@ 
File: lib/builder.js

 
     

 

-
                     

                 

             

diff --git a/output/api/files/lib_cli.js.html b/output/api/files/lib_cli.js.html
index b873060e..c2d4bd79 100644
--- a/output/api/files/lib_cli.js.html
+++ b/output/api/files/lib_cli.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,94 +25,78 @@ 

         

             
             

         

         

                 

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
+                    Show:
+                    
+            
+                    
+            
+                    
+                    
+            
+                

+            
             

                 

                     

-                        
File: lib/cli.js

+
File: lib/cli.js

 
 

     
 #!/usr/bin/env node
 
-/*
-Copyright (c) 2011, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://yuilibrary.com/license/
-*/
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 
 /**
  * Parses the arguments, creates the options and passes them to `Y.YUIDoc` and then `Y.DocBuilder`.
@@ -160,7 +142,6 @@ 
File: lib/cli.js

 
     

 

-
                     

                 

             

diff --git a/output/api/files/lib_docparser.js.html b/output/api/files/lib_docparser.js.html
index b402b833..47020a44 100644
--- a/output/api/files/lib_docparser.js.html
+++ b/output/api/files/lib_docparser.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,92 +25,76 @@ 

         

             
-    

-

-
-            

-        

-        

-                

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
             

                 

                     

-                        
File: lib/docparser.js

+
File: lib/docparser.js

 
 

     
-/*
-Copyright (c) 2011, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://yuilibrary.com/license/
-*/
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 YUI.add('docparser', function (Y) {
 
     var Lang = Y.Lang,
@@ -185,7 +167,7 @@ 
File: lib/docparser.js

         },
         REGEX_LINE_HEAD_CHAR = {
             js: /^\s*\*/,
-            coffee: /^\s*#/
+            coffee: /^\s*[#\*]/
         },
         REGEX_LINES = /\r\n|\n/,
         REGEX_GLOBAL_LINES = /\r\n|\n/g,
@@ -486,7 +468,6 @@ 
File: lib/docparser.js

 
             // @return {type} description // methods
             // @returns {type} description // methods
-            // @throws {type} an error #2173342
             // @injects {HTML|CSS|script} description
             // can be used by anthing that has an optional {type} and a description
             'return': function (tagname, value, target, block) {
@@ -511,7 +492,10 @@ 
File: lib/docparser.js

                 target[tagname] = result;
 
             },
+
+            // @throws {type} description
             'throws': 'return',
+
             'injects': 'return',
 
             // trying to overwrite the constructor value is a bad idea
@@ -909,7 +893,7 @@ 
File: lib/docparser.js

          * @type String
          */
         syntaxtype: {
-            writeOnce: true,
+            writeOnce: true
         },
 
         /**
@@ -1562,7 +1546,6 @@ 
File: lib/docparser.js

 
     

 

-
                     

                 

             

diff --git a/output/api/files/lib_docview.js.html b/output/api/files/lib_docview.js.html
index 5ef54c48..4fa2e94c 100644
--- a/output/api/files/lib_docview.js.html
+++ b/output/api/files/lib_docview.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,92 +25,76 @@ 

         

             
             

         

         

                 

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
+                    Show:
+                    
+            
+                    
+            
+                    
+                    
+            
+                

+            
             

                 

                     

-                        
File: lib/docview.js

+
File: lib/docview.js

 
 

     
-/*
-Copyright (c) 2011, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://yuilibrary.com/license/
-*/
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 YUI.add('docview', function (Y) {
 
     /*
@@ -175,7 +157,6 @@ 
File: lib/docview.js

 
     

 

-
                     

                 

             

diff --git a/output/api/files/lib_files.js.html b/output/api/files/lib_files.js.html
index 0d159091..aaf0579c 100644
--- a/output/api/files/lib_files.js.html
+++ b/output/api/files/lib_files.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,87 +25,76 @@ 

         

             
-    

-

-
-            

-        

-        

-                

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
             

                 

                     

-                        
File: lib/files.js

+
File: lib/files.js

 
 

     
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 YUI.add('files', function (Y) {
 
     /**
@@ -591,7 +578,6 @@ 
File: lib/files.js

 
     

 

-
                     

                 

             

diff --git a/output/api/files/lib_help.js.html b/output/api/files/lib_help.js.html
index d575d9af..8ad1b003 100644
--- a/output/api/files/lib_help.js.html
+++ b/output/api/files/lib_help.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,92 +25,76 @@ 

         

             
             

         

         

                 

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
+                    Show:
+                    
+            
+                    
+            
+                    
+                    
+            
+                

+            
             

                 

                     

-                        
File: lib/help.js

+
File: lib/help.js

 
 

     
-/*
-Copyright (c) 2011, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://yuilibrary.com/license/
-*/
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 YUI.add('help', function (Y) {
 
     /**
@@ -190,7 +172,6 @@ 
File: lib/help.js

 
     

 

-
                     

                 

             

diff --git a/output/api/files/lib_index.js.html b/output/api/files/lib_index.js.html
index 4b6c604c..ff085c65 100644
--- a/output/api/files/lib_index.js.html
+++ b/output/api/files/lib_index.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,92 +25,76 @@ 

         

             
             

         

         

                 

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
+                    Show:
+                    
+            
+                    
+            
+                    
+                    
+            
+                

+            
             

                 

                     

-                        
File: lib/index.js

+
File: lib/index.js

 
 

     
-/*
-Copyright (c) 2011, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://yuilibrary.com/license/
-*/
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 /*global YUI:true, Y:true */
 /**
 Module creates the YUI instance with the required modules, uses them and exports the **Y** to be used
@@ -219,7 +201,6 @@ 
File: lib/index.js

 
     

 

-
                     

                 

             

diff --git a/output/api/files/lib_options.js.html b/output/api/files/lib_options.js.html
index 2c8d9423..fd3c24f6 100644
--- a/output/api/files/lib_options.js.html
+++ b/output/api/files/lib_options.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,87 +25,76 @@ 

         

             
-    

-

-
-            

-        

-        

-                

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
             

                 

                     

-                        
File: lib/options.js

+
File: lib/options.js

 
 

     
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 YUI.add('options', function (Y) {
 
     var path = require('path');
@@ -284,7 +271,6 @@ 
File: lib/options.js

 
     

 

-
                     

                 

             

diff --git a/output/api/files/lib_project.js.html b/output/api/files/lib_project.js.html
new file mode 100644
index 00000000..19aec3fd
--- /dev/null
+++ b/output/api/files/lib_project.js.html
@@ -0,0 +1,178 @@
+
+
+
+    
+    lib/project.js - yuidoc-root
+    
+    
+    
+    
+    
+
+
+
+

+    

+        

+                

+        

+        

+            API Docs for: 0.5.0
+        

+    

+    

+
+        

+            
+        

+        

+                

+                    Show:
+                    
+            
+                    
+            
+                    
+                    
+            
+                

+            
+            

+                

+                    

+
File: lib/project.js

+
+

+    
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
+YUI.add('project', function (Y) {
+
+    Y.Project = {
+        mix: function (json, options) {
+            if (json.project) {
+                options = Y.merge(options, json.project);
+            }
+
+            if (options.title && !options.name) {
+                options.name = options.title;
+            }
+
+            return options;
+        },
+        init: function (options) {
+            var project = {};
+            if (options.configfile) {
+                project = Y.Files.getJSON(options.configfile);
+            } else {
+                Y.log('Scanning for yuidoc.json file.', 'info', 'yuidoc');
+                project = Y.getProjectData();
+                if (!project) {
+                    project = {};
+                }
+            }
+
+            if (project.options && Object.keys(project.options).length) {
+                options = Y.merge(project.options, options);
+                delete project.options;
+                options.project = project;
+            }
+
+            if (options.version && options.project) {
+                options.project.version = options.version;
+                delete options.version;
+            }
+
+            if (!options.outdir) {
+                options.outdir = './out';
+            }
+
+            options.paths = Y.validatePaths(options.paths, options.ignorePaths);
+
+            if (!options.paths.length) {
+                Y.log('Paths argument was empty', 'warn', 'yuidoc');
+                Y.showHelp();
+                process.exit(1);
+            }
+
+            if (typeof options.tabtospace === 'number') {
+                /*jshint onevar:false */
+                options.tabspace = '';
+                for (var s = 0; s < options.tabtospace; s++) {
+                    options.tabspace += ' ';
+                }
+            }
+
+            return options;
+        }
+    };
+
+});
+
+    

+

+                    

+                

+            

+        

+    

+

+
+
+
+
+
+
+
+
+
+
diff --git a/output/api/files/lib_server.js.html b/output/api/files/lib_server.js.html
index 48a07aaa..b542135e 100644
--- a/output/api/files/lib_server.js.html
+++ b/output/api/files/lib_server.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,87 +25,76 @@ 

         

             
-    

-

-
-            

-        

-        

-                

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
             

                 

                     

-                        
File: lib/server.js

+
File: lib/server.js

 
 

     
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 YUI.add('server', function (Y) {
 
     var path = require('path'),
@@ -208,7 +195,7 @@ 
File: lib/server.js

                     }
 
 
-                    res.send(html.join('\n'), 404);
+                    res.status(404).send(html.join('\n'));
                 });
 
             },
@@ -341,7 +328,6 @@ 
File: lib/server.js

 
     

 

-
                     

                 

             

diff --git a/output/api/files/lib_utils.js.html b/output/api/files/lib_utils.js.html
index 2dbacb11..7e8dea2f 100644
--- a/output/api/files/lib_utils.js.html
+++ b/output/api/files/lib_utils.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,92 +25,76 @@ 

         

             
-    

-

-
-            

-        

-        

-                

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
             

                 

                     

-                        
File: lib/utils.js

+
File: lib/utils.js

 
 

     
-/*
-Copyright (c) 2011, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://yuilibrary.com/license/
-*/
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 /*jshint onevar:false */
 var path = require('path'),
     minimatch = require('minimatch'),
@@ -604,7 +586,6 @@ 
File: lib/utils.js

 
     

 

-
                     

                 

             

diff --git a/output/api/files/lib_yuidoc.js.html b/output/api/files/lib_yuidoc.js.html
index 19a6b22c..cb07fabe 100644
--- a/output/api/files/lib_yuidoc.js.html
+++ b/output/api/files/lib_yuidoc.js.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,92 +25,76 @@ 

         

             
-    

-

-
-            

-        

-        

-                

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
             

                 

                     

-                        
File: lib/yuidoc.js

+
File: lib/yuidoc.js

 
 

     
-/*
-Copyright (c) 2011, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://yuilibrary.com/license/
-*/
+/**
+ * Copyright (c) 2011, Yahoo! Inc. All rights reserved.
+ * Code licensed under the BSD License:
+ * https://github.com/yui/yuidoc/blob/master/LICENSE
+ */
 var fs = require('graceful-fs'),
     rimraf = require('rimraf'),
     path = require('path');
@@ -321,7 +303,7 @@ 
File: lib/yuidoc.js

                             self.filecount++;
                             text = fs.readFileSync(fullpath, Y.charset);
 
-                            self.filemap[fullpath] = text;
+                            self.filemap[fullpath] = text.replace(/\r?\n|\r/g, '\n');
                             self.dirmap[fullpath] = dir;
                             self.getSelleck(fullpath);
 
@@ -527,7 +509,6 @@ 
File: lib/yuidoc.js

 
     

 

-
                     

                 

             

diff --git a/output/api/index.html b/output/api/index.html
index bc913c79..627a6a70 100644
--- a/output/api/index.html
+++ b/output/api/index.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,84 +25,68 @@ 

         

             
             

         

         

                 

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
+                    Show:
+                    
+            
+                    
+            
+                    
+                    
+            
+                

+            
             

                 

                     

-                            

+    

         

             

             Browse to a module or class using the sidebar to view its API documentation.
@@ -125,7 +107,6 @@ 
Keyboard Shortcuts

     

 
 
-
                     

                 

             

diff --git a/output/api/modules/yuidoc.html b/output/api/modules/yuidoc.html
index 866d1fa1..f0b42812 100644
--- a/output/api/modules/yuidoc.html
+++ b/output/api/modules/yuidoc.html
@@ -6,7 +6,7 @@
     
     
     
-    
+    
     
 
 
@@ -14,12 +14,10 @@
 

     

         

-            
-                

-            
+                

         

         

-            API Docs for: 0.4.0
+            API Docs for: 0.5.0
         

     

     

@@ -27,100 +25,78 @@ 

         

             
             

         

         

                 

-        Show:
-        
-
-        
-
-        
-        
-
-    

-
-
+                    Show:
+                    
+            
+                    
+            
+                    
+                    
+            
+                

+            
             

                 

                     

-                        
yuidoc Module

+
yuidoc Module

 

-    
 
-    
 
-    
         

             Defined in: lib/yuidoc.js:49
         

-    
 
-    
 

 
 
-
 

     
This is the module description for the YUIDoc module.

 
var options = {
@@ -134,89 +110,72 @@ 
yuidoc Module

 

 
 
-
 

     

-        
             
This module provides the following classes:

 
             
-        
     

 
     

-        
     

 

-
                     

                 

             

diff --git a/output/args/index.html b/output/args/index.html
index c838e734..ad91b1ad 100644
--- a/output/args/index.html
+++ b/output/args/index.html
@@ -7,14 +7,14 @@
     
     
     
-    
+    
     
 
 
 Fork me on GitHub
 

     

-        
Using YUIDoc

+        
Using YUIDoc

     

     
     

@@ -45,7 +45,7 @@ 
Running YUIDoc on the Command Line

 
 
YUI Doc generates API documentation from a modified JavaDoc syntax.
 
-Current version (0.4.0)
+Current version (0.5.0)
 
 Usage: yuidoc <options> <input path>
 
@@ -354,7 +354,7 @@ 
Example: YUIDoc API

 
 
{
   "name": "YUIDoc",
-  "description": "YUIDoc documentation tool written in Javascript",
+  "description": "YUIDoc documentation tool written in JavaScript",
   "version": "0.2.38",
   "url": "http://yuilibrary.com/projects/yuidoc",
   "logo": "http://yuilibrary.com/img/yui-logo.png",
diff --git a/output/assets/favicon.ico b/output/assets/favicon.ico
new file mode 100644
index 00000000..414ac4fb
Binary files /dev/null and b/output/assets/favicon.ico differ
diff --git a/output/assets/favicon.png b/output/assets/favicon.png
deleted file mode 100644
index 5a95ddab..00000000
Binary files a/output/assets/favicon.png and /dev/null differ
diff --git a/output/index.html b/output/index.html
index b9d23e8f..9ca94c19 100644
--- a/output/index.html
+++ b/output/index.html
@@ -2,19 +2,19 @@
 
 
     
-    YUIDoc - Javascript Documentation Tool
+    YUIDoc - JavaScript Documentation Tool
     
     
     
     
-    
+    
     
 
 
 Fork me on GitHub
 

     

-        
YUIDoc - Javascript Documentation Tool

+        
YUIDoc - JavaScript Documentation Tool

     

     
     
@@ -24,7 +24,7 @@ 
YUIDoc - Javascript Docume
     

         

             

-                
Welcome to YUIDoc 0.4.0!

+                
Welcome to YUIDoc 0.5.0!

 
 

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

                         

                             
    
 
  • 
-Welcome to YUIDoc 0.4.0!
+Welcome to YUIDoc 0.5.0!
 
    • 
 
  • 
 Installation and Usage
diff --git a/output/syntax/index.html b/output/syntax/index.html
index 0317da66..750bc9c7 100644
--- a/output/syntax/index.html
+++ b/output/syntax/index.html
@@ -7,14 +7,14 @@
     
     
     
-    
+    
     
 
 
 Fork me on GitHub
 
    
     
    
-        
    YUIDoc Syntax Reference
    
+        
    YUIDoc Syntax Reference
    
     
    
     
     
    
@@ -191,6 +191,7 @@ 
    Primary Tags
    
             @for,
             @param,
             @return,
+            @throws,
             @static.
         
    
     
@@ -707,6 +708,26 @@ 
    Secondary tags
    
         
    
     
 
+
+    throws
+    
+
    /**
+ * @method generateClientId
+ * @throws {Error} An error.
+ */
    
+
+    
+    
+        
    Specifies an error which method throws.
+        A @throws tag has the structure @throws {type} description.
+        The {type} is optional.
    
+        
    
+            See also:
+            @method,
+            @return.
+        
    
+    
+
 
     for
     
diff --git a/output/themes/index.html b/output/themes/index.html
index 13c92947..e907ff0c 100644
--- a/output/themes/index.html
+++ b/output/themes/index.html
@@ -7,14 +7,14 @@
     
     
     
-    
+    
     
 
 
 Fork me on GitHub
 
    
     
    
-        
    YUIDoc Themes
    
+        
    YUIDoc Themes