From 5c0ae88609ada1ba31b1e7c943e6fba64f0073d0 Mon Sep 17 00:00:00 2001 From: Ryuichi Okumura Date: Fri, 6 Mar 2015 22:05:15 +0900 Subject: [PATCH] Build docs --- docs/args/partials/help.mustache | 2 +- output/api/classes/CLI.html | 2 +- output/api/classes/DocBuilder.html | 98 +++--- output/api/classes/DocParser.html | 415 +++++++++++++------------ output/api/classes/DocView.html | 5 +- output/api/classes/Files.html | 18 +- output/api/classes/Help.html | 2 +- output/api/classes/Main.html | 15 +- output/api/classes/Options.html | 2 +- output/api/classes/Server.html | 4 +- output/api/classes/Utils.html | 4 +- output/api/classes/YUIDoc.html | 14 +- output/api/data.json | 119 +++---- output/api/files/lib_builder.js.html | 16 +- output/api/files/lib_cli.js.html | 2 +- output/api/files/lib_docparser.js.html | 18 +- output/api/files/lib_docview.js.html | 2 +- output/api/files/lib_files.js.html | 2 +- output/api/files/lib_help.js.html | 2 +- output/api/files/lib_index.js.html | 2 +- output/api/files/lib_options.js.html | 2 +- output/api/files/lib_project.js.html | 2 +- output/api/files/lib_server.js.html | 2 +- output/api/files/lib_utils.js.html | 2 +- output/api/files/lib_yuidoc.js.html | 2 +- output/api/index.html | 2 +- output/api/modules/yuidoc.html | 12 +- output/args/index.html | 6 +- output/index.html | 4 +- 29 files changed, 414 insertions(+), 364 deletions(-) diff --git a/docs/args/partials/help.mustache b/docs/args/partials/help.mustache index 20477ce9..d63715f6 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.5.0) +Current version (0.6.0) Usage: yuidoc diff --git a/output/api/classes/CLI.html b/output/api/classes/CLI.html index 1ebcc29e..1e6d7b97 100644 --- a/output/api/classes/CLI.html +++ b/output/api/classes/CLI.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/classes/DocBuilder.html b/output/api/classes/DocBuilder.html index 723a8a8c..5af62404 100644 --- a/output/api/classes/DocBuilder.html +++ b/output/api/classes/DocBuilder.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
@@ -357,7 +357,7 @@

_inlineCode

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

@@ -365,8 +365,8 @@

_inlineCode

-

Ported from Selleck, this handles `'s in fields - that are not parsed by the Markdown parser.

+

Ported from Selleck, this handles `'s in fields +that are not parsed by the Markdown parser.

@@ -416,7 +416,7 @@

_mixExternal

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

@@ -458,7 +458,7 @@

_parseCode

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

@@ -528,7 +528,7 @@

_parseCrossLink

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

@@ -609,7 +609,7 @@

addFoundAt

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

@@ -617,7 +617,7 @@

addFoundAt

-

Parses file and line number from an item object and build's an HREF

+

Parses file and line number from an item object and build's an HREF

@@ -675,7 +675,7 @@

augmentData

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

@@ -739,7 +739,7 @@

compile

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

@@ -761,7 +761,7 @@

Parameters:

-

The callback to execute after it's completed

+

The callback to execute after it's completed

@@ -796,7 +796,7 @@

filterFileName

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

@@ -805,8 +805,8 @@

filterFileName

Normalizes a file path to a writable filename:

-

var path = 'lib/file.js'; - returns 'lib_file.js';

+

var path = 'lib/file.js'; +returns 'lib_file.js';

@@ -858,7 +858,7 @@

getProjectMeta

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

@@ -910,7 +910,7 @@

hasProperty

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

@@ -983,7 +983,7 @@

makeDirs

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

@@ -1005,7 +1005,7 @@

Parameters:

-

The callback to execute after it's completed

+

The callback to execute after it's completed

@@ -1022,7 +1022,7 @@

markdown

(
  • - md + data
)
@@ -1058,7 +1058,7 @@

Parameters:

  • - md + data String @@ -1110,7 +1110,7 @@

    mergeExtends

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

    @@ -1187,7 +1187,7 @@

    mixExternal

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

    @@ -1195,7 +1195,7 @@

    mixExternal

    -

    Fetches the remote data and fires the callback when it's all complete

    +

    Fetches the remote data and fires the callback when it's all complete

    @@ -1247,7 +1247,7 @@

    nameSort

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

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

    NATIVES_LINKER

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

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

    populateClasses

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

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

    populateFiles

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

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

    populateModules

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

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

    render

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

    @@ -1607,7 +1607,7 @@

    render

    Ported from Selleck - Renders the handlebars templates with the default View class.

    +Renders the handlebars templates with the default View class.

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

    renderAPIMeta

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

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

    renderClass

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

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

    renderFile

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

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

    renderIndex

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

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

    renderModule

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

    @@ -2091,7 +2091,7 @@

    writeAPIMeta

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

    @@ -2145,7 +2145,7 @@

    writeClasses

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

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

    Parameters:

    -

    The callback to execute after it's completed

    +

    The callback to execute after it's completed

    @@ -2221,7 +2221,7 @@

    writeFiles

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

    @@ -2243,7 +2243,7 @@

    Parameters:

    -

    The callback to execute after it's completed

    +

    The callback to execute after it's completed

    @@ -2297,7 +2297,7 @@

    writeIndex

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

    @@ -2319,7 +2319,7 @@

    Parameters:

    -

    The callback to execute after it's completed

    +

    The callback to execute after it's completed

    @@ -2373,7 +2373,7 @@

    writeModules

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

    @@ -2395,7 +2395,7 @@

    Parameters:

    -

    The callback to execute after it's completed

    +

    The callback to execute after it's completed

    @@ -2445,7 +2445,7 @@

    _mergeCounter

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

    @@ -2471,7 +2471,7 @@

    _meta

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

    @@ -2496,7 +2496,7 @@

    files

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

    @@ -2521,7 +2521,7 @@

    NATIVES

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

    diff --git a/output/api/classes/DocParser.html b/output/api/classes/DocParser.html index db392866..62413cac 100644 --- a/output/api/classes/DocParser.html +++ b/output/api/classes/DocParser.html @@ -17,7 +17,7 @@

    - API Docs for: 0.5.0 + API Docs for: 0.6.0
    @@ -94,7 +94,7 @@

    DocParser Class

    - Defined in: lib/docparser.js:737 + Defined in: lib/docparser.js:749
    Module: yuidoc @@ -105,7 +105,7 @@

    DocParser Class

    The doc parser accepts a map of files to file content. Once parse() is called, various properties will be populated -with the parsers data (aggregated in the 'data' property).

    +with the parsers data (aggregated in the 'data' property).

    @@ -132,7 +132,7 @@

    DocParser

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

    @@ -542,6 +542,10 @@

    Properties

  • DIGESTERS +
    • +
  • + IGNORE_TAGLIST +
  • name @@ -655,7 +659,7 @@

    _addAttrs

    Implementation behind the public addAttrs method.

    This method is invoked directly by get if it encounters a scenario -in which an attribute's valueFn attempts to obtain the +in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).

    @@ -696,7 +700,7 @@

    Parameters:

    Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. -See addAttr.

    +See <a href="#method_addAttr">addAttr</a>.

    @@ -824,8 +828,8 @@

    _addOutOfOrder

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

    _cloneDefaultValue

    This method assumes that the value has already been checked to be an object. -Since it's on a critical path, we don't want to re-do the check.

    +Since it's on a critical path, we don't want to re-do the check.

    @@ -1142,7 +1146,7 @@

    Parameters:

    -

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

    +

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

    @@ -1484,7 +1488,7 @@

    Parameters:

    -

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

    +

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

    @@ -1543,7 +1547,7 @@

    _getAttr

    Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.

    -

    See get for argument details.

    +

    See <a href="#method_get">get</a> for argument details.

    @@ -2282,8 +2286,8 @@

    Parameters:

    -

    The attributes to add during construction (passed through to addAttrs). - These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

    +

    The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). +These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

    @@ -2294,8 +2298,8 @@

    Parameters:

    -

    The initial attribute values to apply (passed through to addAttrs). - These are not merged/cloned. The caller is responsible for isolating user provided values if required.

    +

    The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). +These are not merged/cloned. The caller is responsible for isolating user provided values if required.

    @@ -2306,7 +2310,7 @@

    Parameters:

    -

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

    +

    Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).

    @@ -2403,8 +2407,8 @@

    Parameters:

    -

    The attributes to add during construction (passed through to addAttrs). - These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

    +

    The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). +These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

    @@ -2415,8 +2419,8 @@

    Parameters:

    -

    The initial attribute values to apply (passed through to addAttrs). - These are not merged/cloned. The caller is responsible for isolating user provided values if required.

    +

    The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). +These are not merged/cloned. The caller is responsible for isolating user provided values if required.

    @@ -2427,7 +2431,7 @@

    Parameters:

    -

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

    +

    Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).

    @@ -2524,8 +2528,8 @@

    _initHierarchy

    Initializes the class hierarchy for the instance, which includes -initializing attributes for each class defined in the class's -static ATTRS property and +initializing attributes for each class defined in the class's +static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and invoking the initializer method on the prototype of each class in the hierarchy.

    @@ -2646,7 +2650,7 @@

    Returns:

    Boolean: -

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

    +

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

    @@ -2690,13 +2694,13 @@

    _monitor

    This is the entry point for the event monitoring system. -You can monitor 'attach', 'detach', 'fire', and 'publish'. +You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> click_attach, click_detach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring -turned on or off (publish can't be turned off before it -it published) by setting the events 'monitor' config.

    +turned on or off (publish can't be turned off before it +it published) by setting the events 'monitor' config.

    @@ -2710,7 +2714,7 @@

    Parameters:

    -

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

    +

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

    @@ -2733,7 +2737,7 @@

    Parameters:

    Information about the event interaction, such as - fire() args, subscription category, publish config

    +fire() args, subscription category, publish config

    @@ -2840,7 +2844,7 @@

    _parseType

    Returns an array with the detach key (if provided), and the prefixed event name from _getType -Y.on('detachcategory| menu:click', fn)

    +Y.on('detachcategory| menu:click', fn)

    @@ -3018,7 +3022,7 @@

    _publish

    The low level event publish implementation. It expects all the massaging to have been done -outside of this method. e.g. the type to fullType conversion. It's designed to be a fast +outside of this method. e.g. the type to fullType conversion. It's designed to be a fast path publish, which can be used by critical code paths to improve performance.

    @@ -3101,7 +3105,7 @@

    _resolveFor

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

    @@ -3186,7 +3190,7 @@

    _set

    -

    Allows setting of readOnly/writeOnce attributes. See set for argument details.

    +

    Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.

    @@ -3287,7 +3291,7 @@

    _setAttr

    Provides the common implementation for the public set and protected _set methods.

    -

    See set for argument details.

    +

    See <a href="#method_set">set</a> for argument details.

    @@ -3692,86 +3696,72 @@

    addAttr

-

+

<p> Adds an attribute with the provided configuration to the host object. -

-

+</p> +<p> The config argument object supports the following properties: -

- -
-
value <Any>
-
The initial value to set on the attribute
- -
valueFn <Function | String>
-
-

A function, which will return the initial value to set on the attribute. This is useful - for cases where the attribute configuration is defined statically, but needs to - reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, - the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which - case the value property is used.

- -

valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.

-
- -
readOnly <boolean>
-
Whether or not the attribute is read only. Attributes having readOnly set to true - cannot be modified by invoking the set method.
- -
writeOnce <boolean> or <string>
-
- Whether or not the attribute is "write once". Attributes having writeOnce set to true, - can only have their values set once, be it through the default configuration, - constructor configuration arguments, or by invoking set. -

The writeOnce attribute can also be set to the string "initOnly", - in which case the attribute can only be set during initialization - (when used with Base, this means it can only be set during construction)

-
- -
setter <Function | String>
-
-

The setter function used to massage or normalize the value passed to the set method for the attribute. - The value returned by the setter will be the final stored value. Returning - Attribute.INVALID_VALUE, from the setter will prevent - the value from being stored. -

- -

setter can also be set to a string, representing the name of the instance method to be used as the setter function.

-
- -
getter <Function | String>
-
-

- The getter function used to massage or normalize the value returned by the get method for the attribute. - The value returned by the getter function is the value which will be returned to the user when they - invoke get. -

- -

getter can also be set to a string, representing the name of the instance method to be used as the getter function.

-
- -
validator <Function | String>
-
-

- The validator function invoked prior to setting the stored value. Returning - false from the validator function will prevent the value from being stored. -

- -

validator can also be set to a string, representing the name of the instance method to be used as the validator function.

-
- -
lazyAdd <boolean>
-
Whether or not to delay initialization of the attribute until the first call to get/set it. - This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through - the addAttrs method.
- -
- -

The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with -the context ("this") set to the host object.

- -

Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, -and are not intended for public use.

+</p>

+

<dl> +<dt>value <Any></dt> +<dd>The initial value to set on the attribute</dd>

+

<dt>valueFn <Function | String></dt> +<dd> +<p>A function, which will return the initial value to set on the attribute. This is useful +for cases where the attribute configuration is defined statically, but needs to +reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, +the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which +case the value property is used.</p>

+

<p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p> +</dd>

+

<dt>readOnly <boolean></dt> +<dd>Whether or not the attribute is read only. Attributes having readOnly set to true +cannot be modified by invoking the set method.</dd>

+

<dt>writeOnce <boolean> or <string></dt> +<dd> +Whether or not the attribute is "write once". Attributes having writeOnce set to true, +can only have their values set once, be it through the default configuration, +constructor configuration arguments, or by invoking set. +<p>The writeOnce attribute can also be set to the string "initOnly", +in which case the attribute can only be set during initialization +(when used with Base, this means it can only be set during construction)</p> +</dd>

+

<dt>setter <Function | String></dt> +<dd> +<p>The setter function used to massage or normalize the value passed to the set method for the attribute. +The value returned by the setter will be the final stored value. Returning +<a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent +the value from being stored. +</p>

+

<p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p> +</dd>

+

<dt>getter <Function | String></dt> +<dd> +<p> +The getter function used to massage or normalize the value returned by the get method for the attribute. +The value returned by the getter function is the value which will be returned to the user when they +invoke get. +</p>

+

<p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p> +</dd>

+

<dt>validator <Function | String></dt> +<dd> +<p> +The validator function invoked prior to setting the stored value. Returning +false from the validator function will prevent the value from being stored. +</p>

+

<p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p> +</dd>

+

<dt>lazyAdd <boolean></dt> +<dd>Whether or not to delay initialization of the attribute until the first call to get/set it. +This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through +the <a href="#method_addAttrs">addAttrs</a> method.</dd>

+

</dl>

+

<p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with +the context ("this") set to the host object.</p>

+

<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, +and are not intended for public use.</p>

+
@@ -3796,10 +3786,11 @@

Parameters:

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

-

-NOTE: The configuration object is modified when adding an attribute, so if you need +

<p> +<strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object. -

+</p>

+
@@ -3869,10 +3860,11 @@

addAttrs

Configures a group of attributes, and sets initial values.

-

-NOTE: This method does not isolate the configuration object by merging/cloning. +

<p> +<strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required. -

+</p>

+
@@ -3910,7 +3902,7 @@

Parameters:

Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. -See addAttr.

+See <a href="#method_addAttr">addAttr</a>.

@@ -4096,7 +4088,7 @@

Returns:

EventHandle:

A subscription handle capable of detaching the - subscription

+subscription

@@ -4162,8 +4154,8 @@

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.

+

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.

@@ -4385,9 +4377,9 @@

Parameters:

Either the handle to the subscriber or the - type of event. If the type - is not specified, it will attempt to remove - the listener from all hosted events.

+type of event. If the type +is not specified, it will attempt to remove +the listener from all hosted events.

@@ -4399,7 +4391,7 @@

Parameters:

The subscribed function to unsubscribe, if not - supplied, all subscribers will be removed.

+supplied, all subscribers will be removed.

@@ -4411,10 +4403,10 @@

Parameters:

The custom object passed to subscribe. This is - optional, but if supplied will be used to - disambiguate multiple listeners that are the same - (e.g., you subscribe many object using a function - that lives on the prototype)

+optional, but if supplied will be used to +disambiguate multiple listeners that are the same +(e.g., you subscribe many object using a function +that lives on the prototype)

@@ -4517,7 +4509,7 @@

extract

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

@@ -4527,8 +4519,8 @@

extract

Accepts a map of filenames to file content. Returns a map of filenames to an array of API comment block -text. This expects the comment to start with / * -on its own line, and end with / on its own +text. This expects the comment to start with / ** +on its own line, and end with * / on its own line. Override this function to provide an alternative comment parser.

@@ -4619,9 +4611,9 @@

fire

object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.

-

If the custom event object hasn't been created, then the event hasn't +

If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we -immediate exit in this case. This means the event won't bubble, so +immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.

@@ -4638,7 +4630,7 @@

Parameters:

The type of the event, or an object that contains -a 'type' property.

+a 'type' property.

@@ -4707,8 +4699,8 @@

get

Returns the current value of the attribute. If the attribute -has been configured with a 'getter' function, this method will delegate -to the 'getter' to obtain the value of the attribute.

+has been configured with a 'getter' function, this method will delegate +to the 'getter' to obtain the value of the attribute.

@@ -4723,7 +4715,7 @@

Parameters:

The name of the attribute. If the value of the attribute is an Object, -dot notation can be used to obtain the value of a property of the object (e.g. get("x.y.z"))

+dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)

@@ -4960,7 +4952,7 @@

handlecomment

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

@@ -4969,7 +4961,7 @@

handlecomment

Transforms a JavaDoc style comment block (less the start and end of it) -into a list of tag/text pairs. The leading space and '*' are removed, +into a list of tag/text pairs. The leading space and '*' are removed, but the remaining whitespace is preserved so that the output should be friendly for both markdown and html parsers.

@@ -5255,25 +5247,26 @@

modifyAttr

-

Updates the configuration of an attribute which has already been added.

-

+

Updates the configuration of an attribute which has already been added. +<p> The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute: -

-
-
readOnly;
-
writeOnce;
-
broadcast; and
-
getter.
-
-

+</p> +<dl> +<dt>readOnly;</dt> +<dt>writeOnce;</dt> +<dt>broadcast; and</dt> +<dt>getter.</dt> +</dl> +<p> Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base). -

+</p>

+
@@ -5352,10 +5345,11 @@

on

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

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

Callback functions for events published with emitFacade = true will + +

Callback functions for events published with emitFacade = true will receive an EventFacade as the first argument (typically named "e"). These callbacks can then call e.preventDefault() to disable the -behavior published to that event's defaultFn. See the EventFacade +behavior published to that event's defaultFn. See the EventFacade API for all available properties and methods. Subscribers to non-emitFacade events will receive the arguments passed to fire() after the event name.

@@ -5365,10 +5359,12 @@

on

"attrChange" : this._onAttrChange, "change" : this._onChange }); -

You can also pass an array of event names as the first argument to + +

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

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

Returning false from a callback is supported as an alternative to + +

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

@@ -5433,7 +5429,7 @@

Returns:

EventHandle:

A subscription handle capable of detaching that - subscription

+subscription

@@ -5482,7 +5478,7 @@

once

Listen to a custom event hosted by this object one time. -This is the equivalent to on except the +This is the equivalent to <code>on</code> except the listener is immediatelly detached when it is executed.

@@ -5546,7 +5542,7 @@

Returns:

EventHandle:

A subscription handle capable of detaching the - subscription

+subscription

@@ -5595,7 +5591,7 @@

onceAfter

Listen to a custom event hosted by this object one time. -This is the equivalent to after except the +This is the equivalent to <code>after</code> except the listener is immediatelly detached when it is executed.

@@ -5659,7 +5655,7 @@

Returns:

EventHandle:

A subscription handle capable of detaching that - subscription

+subscription

@@ -5693,7 +5689,7 @@

parse

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

@@ -5783,7 +5779,7 @@

parseType

-

Takes the type parameter passed to 'on' and parses out the +

Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target @@ -5860,7 +5856,7 @@

processblock

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

@@ -5967,7 +5963,7 @@

Parameters:

whether or not the YUI instance and YUI global - are notified when the event is fired.

+are notified when the event is fired.

@@ -5979,7 +5975,7 @@

Parameters:

Whether or not this event bubbles. Events can - only bubble if emitFacade is true.

+only bubble if emitFacade is true.

@@ -6002,7 +5998,7 @@

Parameters:

the default function to execute when this event - fires if preventDefault was not called.

+fires if preventDefault was not called.

@@ -6024,7 +6020,7 @@

Parameters:

optional
-

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

+

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

@@ -6036,7 +6032,7 @@

Parameters:

if an event is configured to fire once, - new subscribers after the fire will be notified immediately.

+new subscribers after the fire will be notified immediately.

@@ -6048,7 +6044,7 @@

Parameters:

fireOnce event listeners will fire synchronously - if the event has already fired unless async is true.

+if the event has already fired unless async is true.

@@ -6115,7 +6111,7 @@

Parameters:

specifies whether or not this event should send notifications about - when the event has been attached, detached, or published.

+when the event has been attached, detached, or published.

@@ -6383,7 +6379,7 @@

Parameters:

The name of the attribute. If the current value of the attribute is an Object, dot notation can be used -to set the value of a property within the object (e.g. set("x.y.z", 5)).

+to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).

@@ -6680,7 +6676,7 @@

transform

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

@@ -6749,7 +6745,7 @@

unindent

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

@@ -6933,7 +6929,7 @@

CORRECTIONS

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

@@ -6959,7 +6955,7 @@

DIGESTERS

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

@@ -6975,6 +6971,33 @@

DIGESTERS

+
+
+

IGNORE_TAGLIST

+ Array + + + + final + + +
+

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

+ + +
+ +
+

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

+ +
+ + +

name

@@ -7051,7 +7074,7 @@

currentclass

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

@@ -7130,7 +7153,7 @@

currentfile

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

@@ -7209,7 +7232,7 @@

currentmodule

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

@@ -7288,7 +7311,7 @@

currentsubmodule

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

@@ -7449,7 +7472,7 @@

digesters

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

@@ -7538,7 +7561,7 @@

dirmap

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

@@ -7619,7 +7642,7 @@

emitters

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

@@ -7699,7 +7722,7 @@

filemap

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

@@ -7860,7 +7883,7 @@

mainmodule

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

@@ -7939,7 +7962,7 @@

syntaxtype

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

@@ -8026,17 +8049,18 @@

destroy

-

+

<p> 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. -

-

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

+ </p>

+
@@ -8077,16 +8101,17 @@

init

-

+

<p> 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. -

-

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

+ </p>

+
diff --git a/output/api/classes/DocView.html b/output/api/classes/DocView.html index 67cbe517..6333c89b 100644 --- a/output/api/classes/DocView.html +++ b/output/api/classes/DocView.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
@@ -100,7 +100,8 @@

DocView Class

-

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

+

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

diff --git a/output/api/classes/Files.html b/output/api/classes/Files.html index 56117a13..b6863479 100644 --- a/output/api/classes/Files.html +++ b/output/api/classes/Files.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
@@ -350,7 +350,7 @@

Parameters:

Whether or not to overwrite destination files - if they already exist.

+if they already exist.

@@ -448,7 +448,7 @@

Parameters:

Whether or not to overwrite destination files - if they already exist.

+if they already exist.

@@ -520,7 +520,7 @@

copyPath

-

If source is a file, copies it to dest. If it's a directory, recursively +

If source is a file, copies it to dest. If it's a directory, recursively copies it and all files and directories it contains to dest.

Note that when attempting to copy a file into a directory, you should specify the full path to the new file (including the new filename). Otherwise, it will @@ -528,7 +528,7 @@

copyPath

directory instead of into it.

Known issues:

    -
  • Doesn't preserve ownership or permissions on copied files/directories.
    • +
  • Doesn't preserve ownership or permissions on copied files/directories.
@@ -983,7 +983,7 @@

lstatSync

Like fs.lstatSync(), but returns null instead of throwing when path -doesn't exist. Will still throw on other types of errors.

+doesn't exist. Will still throw on other types of errors.

@@ -1010,7 +1010,7 @@

Returns:

fs.Stats | Null: -

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

+

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

@@ -1050,7 +1050,7 @@

statSync

Like fs.statSync(), but returns null instead of throwing when path -doesn't exist. Will still throw on other types of errors.

+doesn't exist. Will still throw on other types of errors.

@@ -1077,7 +1077,7 @@

Returns:

fs.Stats | Null: -

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

+

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

diff --git a/output/api/classes/Help.html b/output/api/classes/Help.html index 377f583e..1d512d57 100644 --- a/output/api/classes/Help.html +++ b/output/api/classes/Help.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/classes/Main.html b/output/api/classes/Main.html index c7bf8736..a1da84cc 100644 --- a/output/api/classes/Main.html +++ b/output/api/classes/Main.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
@@ -101,15 +101,16 @@

Main Class

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:

+by the CLI class or by extenders: require('yuidocjs');
+You can use it like this:

var options = {
-    paths: [ './lib' ],
-    outdir: './out'
+    paths: [ './lib' ],
+    outdir: './out'
 };
 
-var Y = require('yuidocjs');
-var json = (new Y.YUIDoc(options)).run();
-
+var Y = require('yuidocjs'); +var json = (new Y.YUIDoc(options)).run(); +
diff --git a/output/api/classes/Options.html b/output/api/classes/Options.html index 4bf43de7..994a7575 100644 --- a/output/api/classes/Options.html +++ b/output/api/classes/Options.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/classes/Server.html b/output/api/classes/Server.html index 08f5c406..a55ea115 100644 --- a/output/api/classes/Server.html +++ b/output/api/classes/Server.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
@@ -400,7 +400,7 @@

init

-

Creates the Express server and prep's YUI for serving

+

Creates the Express server and prep's YUI for serving

diff --git a/output/api/classes/Utils.html b/output/api/classes/Utils.html index 8037d11c..bef4e0d8 100644 --- a/output/api/classes/Utils.html +++ b/output/api/classes/Utils.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
@@ -976,7 +976,7 @@

webpath

Produces a normalized web path by joining all the parts and normalizing the filesystem-like path into web compatible url. Supports relative and absolute paths. -Courtesy of Mojito's utils

+Courtesy of Mojito's utils

diff --git a/output/api/classes/YUIDoc.html b/output/api/classes/YUIDoc.html index ad735c91..5d02cb84 100644 --- a/output/api/classes/YUIDoc.html +++ b/output/api/classes/YUIDoc.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
@@ -102,13 +102,13 @@

YUIDoc Class

YUIDoc main class

   var options = {
-       paths: [ './lib' ],
-       outdir: './out'
+       paths: [ './lib' ],
+       outdir: './out'
    };
 
-   var Y = require('yuidoc');
-   var json = (new Y.YUIDoc(options)).run();
-
+ var Y = require('yuidoc'); + var json = (new Y.YUIDoc(options)).run(); +
@@ -522,7 +522,7 @@

runPreprocessors

-

Applies preprocessors to the data tree. +

Applies preprocessors to the data tree. This function first clones the data and operates on the clone.

diff --git a/output/api/data.json b/output/api/data.json index 0824035f..c84ea301 100644 --- a/output/api/data.json +++ b/output/api/data.json @@ -2,7 +2,7 @@ "project": { "name": "yuidoc-root", "description": "YUIDoc, YUI's JavaScript Documentation engine.", - "version": "0.5.0" + "version": "0.6.0" }, "files": { "lib/builder.js": { @@ -186,7 +186,7 @@ "module": "yuidoc", "namespace": "", "file": "lib/docparser.js", - "line": 737, + "line": 749, "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, @@ -369,7 +369,7 @@ "tagname": "", "params": [ { - "name": "md", + "name": "data", "description": "The Markdown string to parse", "type": "String" } @@ -383,7 +383,7 @@ }, { "file": "lib/builder.js", - "line": 164, + "line": 162, "description": "Parse the item to be cross linked and return an HREF linked to the item", "itemtype": "method", "name": "_parseCrossLink", @@ -414,7 +414,7 @@ }, { "file": "lib/builder.js", - "line": 271, + "line": 269, "description": "List of native types to cross link to MDN", "itemtype": "property", "name": "NATIVES", @@ -424,7 +424,7 @@ }, { "file": "lib/builder.js", - "line": 310, + "line": 308, "description": "Function to link an external type uses `NATIVES` object", "itemtype": "method", "name": "NATIVES_LINKER", @@ -446,7 +446,7 @@ }, { "file": "lib/builder.js", - "line": 324, + "line": 322, "description": "Mixes the various external data soures together into the local data, augmenting\nit with flags.", "itemtype": "method", "name": "_mixExternal", @@ -457,7 +457,7 @@ }, { "file": "lib/builder.js", - "line": 372, + "line": 370, "description": "Fetches the remote data and fires the callback when it's all complete", "itemtype": "method", "name": "mixExternal", @@ -474,7 +474,7 @@ }, { "file": "lib/builder.js", - "line": 447, + "line": 445, "description": "File counter", "itemtype": "property", "name": "files", @@ -484,7 +484,7 @@ }, { "file": "lib/builder.js", - "line": 453, + "line": 451, "description": "Holder for project meta data", "itemtype": "property", "name": "_meta", @@ -496,7 +496,7 @@ }, { "file": "lib/builder.js", - "line": 460, + "line": 458, "description": "Prep the meta data to be fed to Selleck", "itemtype": "method", "name": "getProjectMeta", @@ -509,7 +509,7 @@ }, { "file": "lib/builder.js", - "line": 503, + "line": 501, "description": "Populate the meta data for classes", "itemtype": "method", "name": "populateClasses", @@ -529,7 +529,7 @@ }, { "file": "lib/builder.js", - "line": 527, + "line": 525, "description": "Populate the meta data for modules", "itemtype": "method", "name": "populateModules", @@ -549,7 +549,7 @@ }, { "file": "lib/builder.js", - "line": 573, + "line": 571, "description": "Populate the meta data for files", "itemtype": "method", "name": "populateFiles", @@ -569,7 +569,7 @@ }, { "file": "lib/builder.js", - "line": 630, + "line": 628, "description": "Parses file and line number from an item object and build's an HREF", "itemtype": "method", "name": "addFoundAt", @@ -589,7 +589,7 @@ }, { "file": "lib/builder.js", - "line": 646, + "line": 644, "description": "Augments the **DocParser** meta data to provide default values for certain keys as well as parses all descriptions\nwith the `Markdown Parser`", "itemtype": "method", "name": "augmentData", @@ -609,7 +609,7 @@ }, { "file": "lib/builder.js", - "line": 707, + "line": 705, "description": "Makes the default directories needed", "itemtype": "method", "name": "makeDirs", @@ -625,7 +625,7 @@ }, { "file": "lib/builder.js", - "line": 760, + "line": 758, "description": "Parses `
` tags and adds the __prettyprint__ `className` to them",
             "itemtype": "method",
             "name": "_parseCode",
@@ -647,7 +647,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 773,
+            "line": 771,
             "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",
@@ -669,7 +669,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 792,
+            "line": 790,
             "description": "Ported from [Selleck](https://github.com/rgrove/selleck)\n       Renders the handlebars templates with the default View class.",
             "itemtype": "method",
             "name": "render",
@@ -721,7 +721,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 848,
+            "line": 846,
             "description": "Render the index file",
             "itemtype": "method",
             "name": "renderIndex",
@@ -749,7 +749,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 873,
+            "line": 871,
             "description": "Generates the index.html file",
             "itemtype": "method",
             "name": "writeIndex",
@@ -777,7 +777,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 899,
+            "line": 897,
             "description": "Render a module",
             "itemtype": "method",
             "name": "renderModule",
@@ -805,7 +805,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 983,
+            "line": 981,
             "description": "Generates the module files under \"out\"/modules/",
             "itemtype": "method",
             "name": "writeModules",
@@ -833,7 +833,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1026,
+            "line": 1024,
             "description": "Checks an array of items (class items) to see if an item is in that list",
             "itemtype": "method",
             "name": "hasProperty",
@@ -857,7 +857,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1043,
+            "line": 1041,
             "description": "Counter for stepping into merges",
             "access": "private",
             "tagname": "",
@@ -869,7 +869,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1050,
+            "line": 1048,
             "description": "Merge superclass data into a child class",
             "itemtype": "method",
             "name": "mergeExtends",
@@ -895,7 +895,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1102,
+            "line": 1100,
             "description": "Render the class file",
             "itemtype": "method",
             "name": "renderClass",
@@ -923,7 +923,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1390,
+            "line": 1388,
             "description": "Generates the class files under \"out\"/classes/",
             "itemtype": "method",
             "name": "writeClasses",
@@ -951,7 +951,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1433,
+            "line": 1431,
             "description": "Sort method of array of objects with a property called __name__",
             "itemtype": "method",
             "name": "nameSort",
@@ -976,7 +976,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1456,
+            "line": 1454,
             "description": "Generates the syntax files under `\"out\"/files/`",
             "itemtype": "method",
             "name": "writeFiles",
@@ -1004,7 +1004,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1506,
+            "line": 1504,
             "description": "Render the source file",
             "itemtype": "method",
             "name": "renderFile",
@@ -1032,7 +1032,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1560,
+            "line": 1558,
             "description": "Write the API meta data used for the AutoComplete widget",
             "itemtype": "method",
             "name": "writeAPIMeta",
@@ -1049,7 +1049,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1573,
+            "line": 1571,
             "description": "Render the API meta and return the JavaScript",
             "itemtype": "method",
             "name": "renderAPIMeta",
@@ -1073,7 +1073,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1606,
+            "line": 1604,
             "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",
@@ -1093,7 +1093,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1619,
+            "line": 1617,
             "description": "Compiles the templates from the meta-data provided by DocParser",
             "itemtype": "method",
             "name": "compile",
@@ -1201,6 +1201,17 @@
         {
             "file": "lib/docparser.js",
             "line": 174,
+            "description": "A list of ignored tags. These tags should be ignored because there is\nlikely to be used for purposes other than JSDoc tags in JavaScript comments.",
+            "itemtype": "property",
+            "name": "IGNORE_TAGLIST",
+            "type": "Array",
+            "final": 1,
+            "class": "DocParser",
+            "module": "yuidoc"
+        },
+        {
+            "file": "lib/docparser.js",
+            "line": 186,
             "description": "Common errors will get scrubbed instead of being ignored.",
             "itemtype": "property",
             "name": "CORRECTIONS",
@@ -1211,7 +1222,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 197,
+            "line": 209,
             "description": "A map of the default tag processors, keyed by the\ntag name.  Multiple tags can use the same digester\nby supplying the string name that points to the\nimplementation rather than a function.",
             "itemtype": "property",
             "name": "DIGESTERS",
@@ -1222,7 +1233,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 765,
+            "line": 777,
             "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",
@@ -1231,7 +1242,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 787,
+            "line": 799,
             "description": "Emitters will be schemas for the types of payloads\nthe parser will emit.  Not implemented.",
             "itemtype": "attribute",
             "name": "emitters",
@@ -1240,7 +1251,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 798,
+            "line": 810,
             "description": "Comment syntax type.",
             "itemtype": "attribute",
             "name": "syntaxtype",
@@ -1250,7 +1261,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 807,
+            "line": 819,
             "description": "The map of file names to file content.",
             "itemtype": "attribute",
             "name": "filemap",
@@ -1259,7 +1270,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 815,
+            "line": 827,
             "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",
@@ -1268,7 +1279,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 825,
+            "line": 837,
             "description": "The file currently being parsed",
             "itemtype": "attribute",
             "name": "currentfile",
@@ -1278,7 +1289,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 846,
+            "line": 858,
             "description": "The main documentation block for the module itself.",
             "itemtype": "attribute",
             "name": "mainmodule",
@@ -1288,7 +1299,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 882,
+            "line": 894,
             "description": "The module currently being parsed",
             "itemtype": "attribute",
             "name": "currentmodule",
@@ -1298,7 +1309,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 941,
+            "line": 953,
             "description": "The submodule currently being parsed",
             "itemtype": "attribute",
             "name": "currentsubmodule",
@@ -1308,7 +1319,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 981,
+            "line": 993,
             "description": "The class currently being parsed",
             "itemtype": "attribute",
             "name": "currentclass",
@@ -1318,7 +1329,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1021,
+            "line": 1033,
             "description": "Takes a non-namespaced classname and resolves it to a namespace (to support `@for`)",
             "access": "private",
             "tagname": "",
@@ -1340,7 +1351,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1095,
+            "line": 1107,
             "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",
@@ -1362,7 +1373,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1116,
+            "line": 1128,
             "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",
@@ -1388,7 +1399,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1192,
+            "line": 1206,
             "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",
@@ -1413,7 +1424,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1247,
+            "line": 1261,
             "description": "Processes all the tags in a single comment block",
             "itemtype": "method",
             "name": "processblock",
@@ -1429,7 +1440,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1320,
+            "line": 1334,
             "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",
@@ -1449,7 +1460,7 @@
         },
         {
             "file": "lib/docparser.js",
-            "line": 1434,
+            "line": 1448,
             "description": "Extracts and transforms the filemap provided to constructor",
             "itemtype": "method",
             "name": "parse",
diff --git a/output/api/files/lib_builder.js.html b/output/api/files/lib_builder.js.html
index 2bc4451f..d94f1e63 100644
--- a/output/api/files/lib_builder.js.html
+++ b/output/api/files/lib_builder.js.html
@@ -17,7 +17,7 @@
- API Docs for: 0.5.0 + API Docs for: 0.6.0
@@ -95,7 +95,7 @@

File: lib/builder.js

* Code licensed under the BSD License: * https://github.com/yui/yuidoc/blob/master/LICENSE */ -var marked = require('marked'), +var MarkdownIt = require('markdown-it'), fs = require('graceful-fs'), noop = function () {}, path = require('path'), @@ -146,7 +146,7 @@

File: lib/builder.js

if (options.themedir) { themeDir = options.themedir; } - + this.md = new MarkdownIt(options.markdown); this.data = data; Y.log('Building..', 'info', 'builder'); this.files = 0; @@ -230,16 +230,15 @@

File: lib/builder.js

* Wrapper around the Markdown parser so it can be normalized or even side stepped * @method markdown * @private - * @param {String} md The Markdown string to parse + * @param {String} data The Markdown string to parse * @return {HTML} The rendered HTML */ - markdown: function (md) { - var html = marked(md, this.options.markdown); + markdown: function (data) { + var html = this.md.render(data); //Only reprocess if helpers were asked for if (this.options.helpers || (html.indexOf('{{#crossLink') > -1)) { - //console.log('MD: ', html); try { - // marked auto-escapes quotation marks (and unfortunately + // markdown-it auto-escapes quotation marks (and unfortunately // does not expose the escaping function) html = html.replace(/&quot;/g, "\""); html = (Y.Handlebars.compile(html))({}); @@ -248,7 +247,6 @@

File: lib/builder.js

html = html.replace(/\\{/g, '{').replace(/\\}/g, '}'); Y.log('Failed to parse Handlebars, probably an unknown helper, skipping..', 'warn', 'builder'); } - //console.log('HB: ', html); } return html; }, diff --git a/output/api/files/lib_cli.js.html b/output/api/files/lib_cli.js.html index c2d4bd79..3c37a314 100644 --- a/output/api/files/lib_cli.js.html +++ b/output/api/files/lib_cli.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/files/lib_docparser.js.html b/output/api/files/lib_docparser.js.html index 47020a44..a79b861c 100644 --- a/output/api/files/lib_docparser.js.html +++ b/output/api/files/lib_docparser.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
@@ -263,6 +263,18 @@

File: lib/docparser.js

"writeonce" // YUI attribute config ], + /** + * A list of ignored tags. These tags should be ignored because there is + * likely to be used for purposes other than JSDoc tags in JavaScript comments. + * @property IGNORE_TAGLIST + * @type Array + * @final + * @for DocParser + */ + IGNORE_TAGLIST = [ + "media" + ], + /** * Common errors will get scrubbed instead of being ignored. * @property CORRECTIONS @@ -1220,6 +1232,7 @@

File: lib/docparser.js

var lines = comment.split(REGEX_LINES), len = lines.length, i, + regex, parts, part, peek, skip, tag, value, results = [{ @@ -1242,7 +1255,8 @@

File: lib/docparser.js

// reconsitute and tokenize the comment block comment = this.unindent(lines.join('\n')); - parts = comment.split(/(?:^|\n)\s*(@\w*)/); + regex = new RegExp('(?:^|\\n)\\s*((?!@' + IGNORE_TAGLIST.join(')(?!@') + ')@\\w*)'); + parts = comment.split(regex); len = parts.length; for (i = 0; i < len; i++) { value = ''; diff --git a/output/api/files/lib_docview.js.html b/output/api/files/lib_docview.js.html index 4fa2e94c..0a0c8e32 100644 --- a/output/api/files/lib_docview.js.html +++ b/output/api/files/lib_docview.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/files/lib_files.js.html b/output/api/files/lib_files.js.html index aaf0579c..56fdd860 100644 --- a/output/api/files/lib_files.js.html +++ b/output/api/files/lib_files.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/files/lib_help.js.html b/output/api/files/lib_help.js.html index 8ad1b003..3e94e799 100644 --- a/output/api/files/lib_help.js.html +++ b/output/api/files/lib_help.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/files/lib_index.js.html b/output/api/files/lib_index.js.html index ff085c65..e0d9d7b4 100644 --- a/output/api/files/lib_index.js.html +++ b/output/api/files/lib_index.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/files/lib_options.js.html b/output/api/files/lib_options.js.html index fd3c24f6..3cd77ead 100644 --- a/output/api/files/lib_options.js.html +++ b/output/api/files/lib_options.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/files/lib_project.js.html b/output/api/files/lib_project.js.html index 19aec3fd..521d82e0 100644 --- a/output/api/files/lib_project.js.html +++ b/output/api/files/lib_project.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/files/lib_server.js.html b/output/api/files/lib_server.js.html index b542135e..a06a5990 100644 --- a/output/api/files/lib_server.js.html +++ b/output/api/files/lib_server.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/files/lib_utils.js.html b/output/api/files/lib_utils.js.html index 7e8dea2f..5c6da9d6 100644 --- a/output/api/files/lib_utils.js.html +++ b/output/api/files/lib_utils.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/files/lib_yuidoc.js.html b/output/api/files/lib_yuidoc.js.html index cb07fabe..bf687bb7 100644 --- a/output/api/files/lib_yuidoc.js.html +++ b/output/api/files/lib_yuidoc.js.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/index.html b/output/api/index.html index 627a6a70..dd73c472 100644 --- a/output/api/index.html +++ b/output/api/index.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
diff --git a/output/api/modules/yuidoc.html b/output/api/modules/yuidoc.html index f0b42812..24f27315 100644 --- a/output/api/modules/yuidoc.html +++ b/output/api/modules/yuidoc.html @@ -17,7 +17,7 @@

- API Docs for: 0.5.0 + API Docs for: 0.6.0
@@ -100,13 +100,13 @@

yuidoc Module

This is the module description for the YUIDoc module.

var options = {
-    paths: [ './lib' ],
-    outdir: './out'
+    paths: [ './lib' ],
+    outdir: './out'
 };
 
-var Y = require('yuidocjs');
-var json = (new Y.YUIDoc(options)).run();
-
+var Y = require('yuidocjs'); +var json = (new Y.YUIDoc(options)).run(); +
diff --git a/output/args/index.html b/output/args/index.html index ad91b1ad..cb73a7c7 100644 --- a/output/args/index.html +++ b/output/args/index.html @@ -45,7 +45,7 @@

Running YUIDoc on the Command Line

YUI Doc generates API documentation from a modified JavaDoc syntax.
 
-Current version (0.5.0)
+Current version (0.6.0)
 
 Usage: yuidoc <options> <input path>
 
@@ -319,8 +319,8 @@ 
YUIDoc Options

 
     markdown
     
-        Options to pass to Marked, the Markdown compiler used to compile API descriptions. 
-        See the Marked readme for details.
+        Options to pass to markdown-it, the Markdown compiler used to compile API descriptions.
+        See the markdown-it API for details.
     
 
 
diff --git a/output/index.html b/output/index.html
index 9ca94c19..6d557e90 100644
--- a/output/index.html
+++ b/output/index.html
@@ -24,7 +24,7 @@ 

         

             

-                
Welcome to YUIDoc 0.5.0!

+                
Welcome to YUIDoc 0.6.0!

 
 

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