From 00f2976413e2cfbf42000cc80bdaf69aaf24cdcc Mon Sep 17 00:00:00 2001 From: Ryuichi Okumura Date: Wed, 29 Apr 2015 21:33:53 +0900 Subject: [PATCH] Build docs --- output/api/classes/DocBuilder.html | 70 +- output/api/classes/DocParser.html | 1321 +++++++++++--------------- output/api/classes/DocView.html | 130 +-- output/api/classes/Utils.html | 26 +- output/api/classes/YUIDoc.html | 102 +- output/api/data.json | 96 +- output/api/files/lib_builder.js.html | 19 +- output/api/files/lib_index.js.html | 13 + output/api/files/lib_options.js.html | 2 - output/api/files/lib_project.js.html | 1 - output/api/files/lib_utils.js.html | 1 - output/index.html | 4 +- 12 files changed, 794 insertions(+), 991 deletions(-) diff --git a/output/api/classes/DocBuilder.html b/output/api/classes/DocBuilder.html index 5af62404..20f623c8 100644 --- a/output/api/classes/DocBuilder.html +++ b/output/api/classes/DocBuilder.html @@ -299,7 +299,7 @@

_addHelpers

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

@@ -357,7 +357,7 @@

_inlineCode

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

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

_mixExternal

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

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

_parseCode

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

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

_parseCrossLink

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

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

addFoundAt

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

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

augmentData

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

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

compile

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

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

filterFileName

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

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

getProjectMeta

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

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

hasProperty

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

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

makeDirs

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

@@ -1041,7 +1041,7 @@

markdown

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

@@ -1110,7 +1110,7 @@

mergeExtends

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

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

mixExternal

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

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

nameSort

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

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

NATIVES_LINKER

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

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

populateClasses

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

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

populateFiles

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

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

populateModules

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

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

render

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

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

renderAPIMeta

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

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

renderClass

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

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

renderFile

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

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

renderIndex

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

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

renderModule

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

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

writeAPIMeta

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

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

writeClasses

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

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

writeFiles

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

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

writeIndex

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

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

writeModules

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

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

_mergeCounter

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

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

_meta

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

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

files

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

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

NATIVES

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

diff --git a/output/api/classes/DocParser.html b/output/api/classes/DocParser.html index 62413cac..e8369ebf 100644 --- a/output/api/classes/DocParser.html +++ b/output/api/classes/DocParser.html @@ -111,59 +111,59 @@

DocParser Class

Constructor

-
-

DocParser

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

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

- - - -
- -
- -
- -
-

Parameters:

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

    the config object

    - -
    - -
    • -
-
- - +
+

DocParser

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

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

+ + + +
+ +
+
+ +
+

Parameters:

+ +
    +
  • + o + Object + + +
    +

    the config object

    + +
    + +
    • +
+ + + +
@@ -657,12 +657,12 @@

_addAttrs

-

Implementation behind the public addAttrs method.

-

This method is invoked directly by get if it encounters a scenario + 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 value an attribute in the same group of attributes, which has not yet -been added (on demand initialization).

- +been added (on demand initialization).
@@ -675,8 +675,7 @@

Parameters:

-

An object with attribute name/configuration pairs.

- + An object with attribute name/configuration pairs.
@@ -686,9 +685,8 @@

Parameters:

-

An object with attribute name/value pairs, defining the initial values to apply. -Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.

- + An object with attribute name/value pairs, defining the initial values to apply. +Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
@@ -698,10 +696,9 @@

Parameters:

-

Whether or not to delay the intialization of these attributes until the first call to get/set. + 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 <a href="#method_addAttr">addAttr</a>.

- +See addAttr.
@@ -744,8 +741,7 @@

_addLazyAttr

-

Finishes initializing an attribute which has been lazily added.

- + Finishes initializing an attribute which has been lazily added.
@@ -758,8 +754,7 @@

Parameters:

-

The name of the attribute

- + The name of the attribute
@@ -770,9 +765,8 @@

Parameters:

-

Optional config hash for the attribute. This is added for performance -along the critical path, where the calling method has already obtained lazy config from state.

- + Optional config hash for the attribute. This is added for performance +along the critical path, where the calling method has already obtained lazy config from state.
@@ -815,21 +809,22 @@

_addOutOfOrder

-

Utility method used by get/set to add attributes -encountered out of order when calling addAttrs().

-

For example, if:

-
this.addAttrs({
-     foo: {
-         setter: function() {
-            // make sure this bar is available when foo is added
-            this.get("bar");
+        Utility method used by get/set to add attributes
+encountered out of order when calling addAttrs().
+
+For example, if:
+
+    this.addAttrs({
+         foo: {
+             setter: function() {
+                // make sure this bar is available when foo is added
+                this.get("bar");
+             }
+         },
+         bar: {
+             value: ...
          }
-     },
-     bar: {
-         value: ...
-     }
-});
- + });
@@ -842,8 +837,7 @@

Parameters:

-

attribute name

- + attribute name
@@ -853,8 +847,7 @@

Parameters:

-

attribute configuration

- + attribute configuration
@@ -897,12 +890,12 @@

_aggregateAttrs

-

A helper method, used by _initHierarchyData to aggregate -attribute configuration across the instances class hierarchy.

-

The method will protect the attribute configuration value to protect the statically defined -default value in ATTRS if required (if the value is an object literal, array or the -attribute configuration has cloneDefaultValue set to shallow or deep).

+ A helper method, used by _initHierarchyData to aggregate +attribute configuration across the instances class hierarchy. +The method will protect the attribute configuration value to protect the statically defined +default value in ATTRS if required (if the value is an object literal, array or the +attribute configuration has cloneDefaultValue set to shallow or deep).
@@ -915,9 +908,8 @@

Parameters:

-

An array of ATTRS definitions across classes in the hierarchy -(subclass first, Base last)

- + An array of ATTRS definitions across classes in the hierarchy +(subclass first, Base last)
@@ -929,8 +921,7 @@

Returns:

Object: -

The aggregate set of ATTRS definitions for the instance

- + The aggregate set of ATTRS definitions for the instance
@@ -960,9 +951,8 @@

_attrCfgHash

-

Utility method to define the attribute hash used to filter/whitelist property mixes for -this class for iteration performance reasons.

- + Utility method to define the attribute hash used to filter/whitelist property mixes for +this class for iteration performance reasons.
@@ -993,8 +983,7 @@

_baseDestroy

-

Internal destroy implementation for BaseCore

- + Internal destroy implementation for BaseCore
@@ -1025,8 +1014,7 @@

_baseInit

-

Internal initialization implementation for BaseCore

- + Internal initialization implementation for BaseCore
@@ -1063,9 +1051,8 @@

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

- + 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.
@@ -1121,8 +1108,7 @@

_defAttrChangeFn

-

Default function for attribute change events.

- + Default function for attribute change events.
@@ -1135,8 +1121,7 @@

Parameters:

-

The event object for attribute change events.

- + The event object for attribute change events.
@@ -1146,8 +1131,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
@@ -1187,8 +1171,7 @@

_defDestroyFn

-

Default destroy event handler

- + Default destroy event handler
@@ -1201,8 +1184,7 @@

Parameters:

-

Event object

- + Event object
@@ -1242,8 +1224,7 @@

_defInitFn

-

Default init event handler

- + Default init event handler
@@ -1256,9 +1237,8 @@

Parameters:

-

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

- + Event object, with a cfg property which +refers to the configuration object passed to the constructor.
@@ -1292,9 +1272,8 @@

_destroyHierarchy

-

Destroys the class hierarchy for this instance by invoking -the destructor method on the prototype of each class in the hierarchy.

- + Destroys the class hierarchy for this instance by invoking +the destructor method on the prototype of each class in the hierarchy.
@@ -1350,10 +1329,9 @@

Parameters:

-

The set of all attribute configurations for this instance. + The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so -that by the time all classes are processed, allCfgs will be empty.

- +that by the time all classes are processed, allCfgs will be empty.
@@ -1363,8 +1341,7 @@

Parameters:

-

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

- + The config object passed in by the user, from which adhoc attrs are to be filtered.
@@ -1376,9 +1353,8 @@

Returns:

Object: -

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

- + The set of adhoc attributes passed in, in the form +of an object with attribute name/configuration pairs.
@@ -1429,8 +1405,7 @@

_fireAttrChange

-

Utility method to help setup the event payload and fire the attribute change event.

- + Utility method to help setup the event payload and fire the attribute change event.
@@ -1443,8 +1418,7 @@

Parameters:

-

The name of the attribute

- + The name of the attribute
@@ -1454,9 +1428,8 @@

Parameters:

-

The full path of the property being changed, -if this is a sub-attribute value being change. Otherwise null.

- + The full path of the property being changed, +if this is a sub-attribute value being change. Otherwise null.
@@ -1466,8 +1439,7 @@

Parameters:

-

The current value of the attribute

- + The current value of the attribute
@@ -1477,8 +1449,7 @@

Parameters:

-

The new value of the attribute

- + The new value of the attribute
@@ -1488,8 +1459,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.
@@ -1500,8 +1470,7 @@

Parameters:

-

The attribute config stored in State, if already available.

- + The attribute config stored in State, if already available.
@@ -1545,10 +1514,10 @@

_getAttr

-

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

-

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

+ Provides the common implementation for the public get method, +allowing Attribute hosts to over-ride either method. +See get for argument details.
@@ -1561,8 +1530,7 @@

Parameters:

-

The name of the attribute.

- + The name of the attribute.
@@ -1574,8 +1542,7 @@

Returns:

Any: -

The value of the attribute.

- + The value of the attribute.
@@ -1614,10 +1581,9 @@

_getAttrCfg

-

Returns an object with the configuration properties (and value) + Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the -configuration properties for all attributes.

- +configuration properties for all attributes.
@@ -1630,8 +1596,7 @@

Parameters:

-

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

- + Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
@@ -1643,8 +1608,7 @@

Returns:

Object: -

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

- + The configuration properties for the given attribute, or all attributes.
@@ -1677,9 +1641,8 @@

_getAttrCfgs

-

Returns an aggregated set of attribute configurations, by traversing -the class hierarchy.

- + Returns an aggregated set of attribute configurations, by traversing +the class hierarchy.
@@ -1688,10 +1651,9 @@

Returns:

Object: -

The hash of attribute configurations, aggregated across classes in the hierarchy + 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.

- +the cached value.
@@ -1736,11 +1698,10 @@

_getAttrInitVal

-

Returns the initial value of the given attribute from + Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues -provided and the attribute is not read-only.

- +provided and the attribute is not read-only.
@@ -1753,8 +1714,7 @@

Parameters:

-

The name of the attribute

- + The name of the attribute
@@ -1764,8 +1724,7 @@

Parameters:

-

The attribute configuration object

- + The attribute configuration object
@@ -1775,8 +1734,7 @@

Parameters:

-

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

- + The object with simple and complex attribute name/value pairs returned from _normAttrVals
@@ -1788,8 +1746,7 @@

Returns:

Any: -

The initial value of the attribute.

- + The initial value of the attribute.
@@ -1828,8 +1785,7 @@

_getAttrs

-

Implementation behind the public getAttrs method, to get multiple attribute values.

- + Implementation behind the public getAttrs method, to get multiple attribute values.
@@ -1842,9 +1798,8 @@

Parameters:

-

Optional. An array of attribute names. If omitted, all attribute values are -returned. If set to true, all attributes modified from their initial values are returned.

- + Optional. An array of attribute names. If omitted, all attribute values are +returned. If set to true, all attributes modified from their initial values are returned.
@@ -1856,8 +1811,7 @@

Returns:

Object: -

An object with attribute name/value pairs.

- + An object with attribute name/value pairs.
@@ -1890,8 +1844,7 @@

_getClasses

-

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

- + Returns the class hierarchy for this object, with BaseCore being the last class in the array.
@@ -1900,10 +1853,9 @@

Returns:

Function[]: -

An array of classes (constructor functions), making up the class hierarchy for this object. + 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.

- +cached value.
@@ -1942,12 +1894,12 @@

_getFullType

-

Returns the fully qualified type, given a short type string. -That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.

-

NOTE: This method, unlike _getType, does no checking of the value passed in, and -is designed to be used with the low level _publish() method, for critical path -implementations which need to fast-track publish for performance reasons.

+ Returns the fully qualified type, given a short type string. +That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix. +NOTE: This method, unlike _getType, does no checking of the value passed in, and +is designed to be used with the low level _publish() method, for critical path +implementations which need to fast-track publish for performance reasons.
@@ -1960,8 +1912,7 @@

Parameters:

-

The short type to prefix

- + The short type to prefix
@@ -1973,8 +1924,7 @@

Returns:

String: -

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

- + The prefixed type, if a prefix is set, otherwise the type passed in
@@ -2013,9 +1963,8 @@

_getInstanceAttrCfgs

-

A helper method used to isolate the attrs config for this instance to pass to addAttrs, -from the static cached ATTRS for the class.

- + A helper method used to isolate the attrs config for this instance to pass to addAttrs, +from the static cached ATTRS for the class.
@@ -2028,10 +1977,9 @@

Parameters:

-

The set of all attribute configurations for this instance. + The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so -that by the time all classes are processed, allCfgs will be empty.

- +that by the time all classes are processed, allCfgs will be empty.
@@ -2043,9 +1991,8 @@

Returns:

Object: -

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

- + The set of attributes to be added for this instance, suitable +for passing through to addAttrs.
@@ -2087,9 +2034,8 @@

_getStateVal

-

Gets the stored value for the attribute, from either the -internal state object, or the state proxy if it exits

- + Gets the stored value for the attribute, from either the +internal state object, or the state proxy if it exits
@@ -2102,8 +2048,7 @@

Parameters:

-

The name of the attribute

- + The name of the attribute
@@ -2114,9 +2059,8 @@

Parameters:

-

Optional config hash for the attribute. This is added for performance along the critical path, -where the calling method has already obtained the config from state.

- + Optional config hash for the attribute. This is added for performance along the critical path, +where the calling method has already obtained the config from state.
@@ -2128,8 +2072,7 @@

Returns:

Any: -

The stored value of the attribute

- + The stored value of the attribute
@@ -2159,10 +2102,9 @@

_getType

-

If the instance has a prefix attribute and the + If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is -applied to the supplied type.

- +applied to the supplied type.
@@ -2215,8 +2157,7 @@

Parameters:

-

The fully prefixed type name

- + The fully prefixed type name
@@ -2228,8 +2169,7 @@

Returns:

Boolean: -

Whether the event has potential subscribers or not

- + Whether the event has potential subscribers or not
@@ -2271,9 +2211,8 @@

_initAttrHost

-

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the -constructor.

- + Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the +constructor.
@@ -2286,9 +2225,8 @@

Parameters:

-

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.

- + 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.
@@ -2298,9 +2236,8 @@

Parameters:

-

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.

- + 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.
@@ -2310,8 +2247,7 @@

Parameters:

-

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

- + Whether or not to add attributes lazily (passed through to addAttrs).
@@ -2348,8 +2284,7 @@

_initAttribute

-

Initializes AttributeCore

- + Initializes AttributeCore
@@ -2392,9 +2327,8 @@

_initAttrs

-

Utility method to set up initial attributes defined during construction, -either through the constructor.ATTRS property, or explicitly passed in.

- + Utility method to set up initial attributes defined during construction, +either through the constructor.ATTRS property, or explicitly passed in.
@@ -2407,9 +2341,8 @@

Parameters:

-

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.

- + 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.
@@ -2419,9 +2352,8 @@

Parameters:

-

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.

- + 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.
@@ -2431,8 +2363,7 @@

Parameters:

-

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

- + Whether or not to add attributes lazily (passed through to addAttrs).
@@ -2472,8 +2403,7 @@

_initBase

-

Internal construction logic for BaseCore.

- + Internal construction logic for BaseCore.
@@ -2486,8 +2416,7 @@

Parameters:

-

The constructor configuration object

- + The constructor configuration object
@@ -2527,11 +2456,10 @@

_initHierarchy

-

Initializes the class hierarchy for the instance, which includes + Initializes the class hierarchy for the instance, which includes 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.

- +static ATTRS property and +invoking the initializer method on the prototype of each class in the hierarchy.
@@ -2544,8 +2472,7 @@

Parameters:

-

Object with configuration property name/value pairs

- + Object with configuration property name/value pairs
@@ -2579,10 +2506,9 @@

_initHierarchyData

-

A helper method used by _getClasses and _getAttrCfgs, which determines both + A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations -across the class hierarchy for the instance.

- +across the class hierarchy for the instance.
@@ -2622,9 +2548,8 @@

_isLazyAttr

-

Checks whether or not the attribute is one which has been -added lazily and still requires initialization.

- + Checks whether or not the attribute is one which has been +added lazily and still requires initialization.
@@ -2637,8 +2562,7 @@

Parameters:

-

The name of the attribute

- + The name of the attribute
@@ -2650,8 +2574,7 @@

Returns:

Boolean: -

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

- + true if it's a lazily added attribute, false otherwise.
@@ -2693,15 +2616,14 @@

_monitor

-

This is the entry point for the event monitoring system. + This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. -When configured, these events generate an event. click -> +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.

- +it published) by setting the events 'monitor' config.
@@ -2714,8 +2636,7 @@

Parameters:

-

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

- + 'attach', 'detach', 'fire', or 'publish'
@@ -2725,8 +2646,7 @@

Parameters:

-

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

- + The prefixed name of the event being monitored, or the CustomEvent object.
@@ -2736,9 +2656,8 @@

Parameters:

-

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

- + Information about the event interaction, such as + fire() args, subscription category, publish config
@@ -2781,9 +2700,8 @@

_normAttrVals

-

Utility method to normalize attribute values. The base implementation -simply merges the hash to protect the original.

- + Utility method to normalize attribute values. The base implementation +simply merges the hash to protect the original.
@@ -2796,8 +2714,7 @@

Parameters:

-

An object with attribute name/value pairs

- + An object with attribute name/value pairs
@@ -2809,10 +2726,9 @@

Returns:

Object: -

An object literal with 2 properties - "simple" and "complex", + 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.

- +by the top level attribute name, or null, if valueHash is falsey.
@@ -2842,10 +2758,9 @@

_parseType

-

Returns an array with the detach key (if provided), + 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)
@@ -2882,10 +2797,9 @@

_preInitEventCfg

-

Handles the special on, after and target properties which allow the user to + Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during -construction, prior to init.

- +construction, prior to init.
@@ -2898,8 +2812,7 @@

Parameters:

-

The user configuration object

- + The user configuration object
@@ -2946,10 +2859,9 @@

_protectAttrs

-

Utility method to protect an attribute configuration + Utility method to protect an attribute configuration hash, by merging the entire object and the individual -attr config objects.

- +attr config objects.
@@ -2962,8 +2874,7 @@

Parameters:

-

A hash of attribute to configuration object pairs.

- + A hash of attribute to configuration object pairs.
@@ -2975,8 +2886,7 @@

Returns:

Object: -

A protected version of the attrs argument.

- + A protected version of the attrs argument.
@@ -3021,10 +2931,9 @@

_publish

-

The low level event publish implementation. It expects all the massaging to have been done + 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 -path publish, which can be used by critical code paths to improve performance.

- +path publish, which can be used by critical code paths to improve performance.
@@ -3037,8 +2946,7 @@

Parameters:

-

The prefixed type of the event to publish.

- + The prefixed type of the event to publish.
@@ -3048,8 +2956,7 @@

Parameters:

-

The EventTarget specific configuration to mix into the published event.

- + The EventTarget specific configuration to mix into the published event.
@@ -3059,8 +2966,7 @@

Parameters:

-

The publish specific configuration to mix into the published event.

- + The publish specific configuration to mix into the published event.
@@ -3072,9 +2978,8 @@

Returns:

CustomEvent: -

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

- + The published event. If called without etOpts or ceOpts, this will +be the default CustomEvent instance, and can be configured independently.
@@ -3190,8 +3095,7 @@

_set

-

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

- + Allows setting of readOnly/writeOnce attributes. See set for argument details.
@@ -3204,8 +3108,7 @@

Parameters:

-

The name of the attribute.

- + The name of the attribute.
@@ -3215,8 +3118,7 @@

Parameters:

-

The value to set the attribute to.

- + The value to set the attribute to.
@@ -3227,8 +3129,7 @@

Parameters:

-

Optional data providing the circumstances for the change.

- + Optional data providing the circumstances for the change.
@@ -3240,8 +3141,7 @@

Returns:

Object: -

A reference to the host object.

- + A reference to the host object.
@@ -3290,9 +3190,9 @@

_setAttr

-

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

-

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

+ Provides the common implementation for the public set and protected _set methods. +See set for argument details.
@@ -3305,8 +3205,7 @@

Parameters:

-

The name of the attribute.

- + The name of the attribute.
@@ -3316,8 +3215,7 @@

Parameters:

-

The value to set the attribute to.

- + The value to set the attribute to.
@@ -3328,8 +3226,7 @@

Parameters:

-

Optional data providing the circumstances for the change.

- + Optional data providing the circumstances for the change.
@@ -3339,9 +3236,8 @@

Parameters:

-

If true, allows the caller to set values for -readOnly or writeOnce attributes which have already been set.

- + If true, allows the caller to set values for +readOnly or writeOnce attributes which have already been set.
@@ -3353,8 +3249,7 @@

Returns:

Object: -

A reference to the host object.

- + A reference to the host object.
@@ -3400,8 +3295,7 @@

_setAttrs

-

Implementation behind the public setAttrs method, to set multiple attribute values.

- + Implementation behind the public setAttrs method, to set multiple attribute values.
@@ -3414,8 +3308,7 @@

Parameters:

-

An object with attributes name/value pairs.

- + An object with attributes name/value pairs.
@@ -3426,8 +3319,7 @@

Parameters:

-

Optional data providing the circumstances for the change

- + Optional data providing the circumstances for the change
@@ -3439,8 +3331,7 @@

Returns:

Object: -

A reference to the host object.

- + A reference to the host object.
@@ -3494,9 +3385,8 @@

_setAttrVal

-

Updates the stored value of the attribute in the privately held State object, -if validation and setter passes.

- + Updates the stored value of the attribute in the privately held State object, +if validation and setter passes.
@@ -3509,8 +3399,7 @@

Parameters:

-

The attribute name.

- + The attribute name.
@@ -3520,8 +3409,7 @@

Parameters:

-

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

- + The sub-attribute name, if setting a sub-attribute property ("x.y.z").
@@ -3531,8 +3419,7 @@

Parameters:

-

The currently stored value of the attribute.

- + The currently stored value of the attribute.
@@ -3542,8 +3429,7 @@

Parameters:

-

The value which is going to be stored.

- + The value which is going to be stored.
@@ -3554,8 +3440,7 @@

Parameters:

-

Optional data providing the circumstances for the change.

- + Optional data providing the circumstances for the change.
@@ -3566,9 +3451,8 @@

Parameters:

-

Optional config hash for the attribute. This is added for performance along the critical path, -where the calling method has already obtained the config from state.

- + Optional config hash for the attribute. This is added for performance along the critical path, +where the calling method has already obtained the config from state.
@@ -3580,8 +3464,7 @@

Returns:

Boolean: -

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

- + true if the new attribute value was stored, false if not.
@@ -3620,9 +3503,8 @@

_setStateVal

-

Sets the stored value for the attribute, in either the -internal state object, or the state proxy if it exits

- + Sets the stored value for the attribute, in either the +internal state object, or the state proxy if it exits
@@ -3635,8 +3517,7 @@

Parameters:

-

The name of the attribute

- + The name of the attribute
@@ -3646,8 +3527,7 @@

Parameters:

-

The value of the attribute

- + The value of the attribute
@@ -3696,72 +3576,86 @@

addAttr

-

<p> +

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

+

The config argument object supports the following properties: -</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>

- +

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

@@ -3774,8 +3668,7 @@

Parameters:

-

The name of the attribute.

- + The name of the attribute.
@@ -3785,12 +3678,12 @@

Parameters:

-

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

-

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

+ 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 +to protect the original values, you will need to merge the object. +

@@ -3800,8 +3693,7 @@

Parameters:

-

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

- + (optional) Whether or not to add this attribute lazily (on the first call to get/set).
@@ -3813,8 +3705,7 @@

Returns:

Object: -

A reference to the host object.

- + A reference to the host object.
@@ -3859,12 +3750,12 @@

addAttrs

-

Configures a group of attributes, and sets initial values.

-

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

+ Configures a group of attributes, and sets initial values. +

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

@@ -3877,8 +3768,7 @@

Parameters:

-

An object with attribute name/configuration pairs.

- + An object with attribute name/configuration pairs.
@@ -3888,9 +3778,8 @@

Parameters:

-

An object with attribute name/value pairs, defining the initial values to apply. -Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.

- + An object with attribute name/value pairs, defining the initial values to apply. +Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
@@ -3900,10 +3789,9 @@

Parameters:

-

Whether or not to delay the intialization of these attributes until the first call to get/set. + 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 <a href="#method_addAttr">addAttr</a>.

- +See addAttr.
@@ -3915,8 +3803,7 @@

Returns:

Object: -

A reference to the host object.

- + A reference to the host object.
@@ -3952,12 +3839,13 @@

addTarget

-

Registers another EventTarget as a bubble target. Bubble order + Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can -be specified.

-

Events can only bubble if emitFacade is true.

-

Included in the event-custom-complex submodule.

+be specified. +Events can only bubble if emitFacade is true. + +Included in the event-custom-complex submodule.
@@ -3970,8 +3858,7 @@

Parameters:

-

the target to add

- + the target to add
@@ -4022,11 +3909,10 @@

after

-

Subscribe to a custom event hosted by this object. The + Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, -if configured for the event, has executed.

- +if configured for the event, has executed.
@@ -4039,8 +3925,7 @@

Parameters:

-

The name of the event

- + The name of the event
@@ -4050,8 +3935,7 @@

Parameters:

-

The callback to execute in response to the event

- + The callback to execute in response to the event
@@ -4062,8 +3946,7 @@

Parameters:

-

Override this object in callback

- + Override this object in callback
@@ -4074,8 +3957,7 @@

Parameters:

-

0..n additional arguments to supply to the subscriber

- + 0..n additional arguments to supply to the subscriber
@@ -4087,9 +3969,8 @@

Returns:

EventHandle: -

A subscription handle capable of detaching the -subscription

- + A subscription handle capable of detaching the + subscription
@@ -4127,8 +4008,7 @@

attrAdded

-

Checks if the given attribute has been added to the host

- + Checks if the given attribute has been added to the host
@@ -4141,8 +4021,7 @@

Parameters:

-

The name of the attribute to check.

- + The name of the attribute to check.
@@ -4154,9 +4033,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.
@@ -4188,15 +4066,16 @@

before

-

Executes the callback before a DOM event, custom event + Executes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom -events, this is an alias for Y.on.

-

For DOM and custom events: -type, callback, context, 0-n arguments

-

For methods: -callback, object (method host), methodName, context, 0-n arguments

+events, this is an alias for Y.on. + +For DOM and custom events: +type, callback, context, 0-n arguments +For methods: +callback, object (method host), methodName, context, 0-n arguments
@@ -4204,8 +4083,7 @@

before

Returns:

-

detach handle

- + detach handle
@@ -4243,8 +4121,7 @@

bubble

-

Propagate an event. Requires the event-custom-complex module.

- + Propagate an event. Requires the event-custom-complex module.
@@ -4257,8 +4134,7 @@

Parameters:

-

the custom event to propagate

- + the custom event to propagate
@@ -4270,8 +4146,7 @@

Returns:

Boolean: -

the aggregated return value from Event.Custom.fire

- + the aggregated return value from Event.Custom.fire
@@ -4307,8 +4182,7 @@

destroy

-

Destroy lifecycle method. Invokes destructors for the class hierarchy.

- + Destroy lifecycle method. Invokes destructors for the class hierarchy.
@@ -4317,8 +4191,7 @@

Returns:

BaseCore: -

A reference to this object

- + A reference to this object
@@ -4362,8 +4235,7 @@

detach

-

Detach one or more listeners the from the specified event

- + Detach one or more listeners the from the specified event
@@ -4376,11 +4248,10 @@

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.

- + 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.
@@ -4390,9 +4261,8 @@

Parameters:

-

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

- + The subscribed function to unsubscribe, if not + supplied, all subscribers will be removed.
@@ -4402,12 +4272,11 @@

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)

- + 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)
@@ -4419,8 +4288,7 @@

Returns:

EventTarget: -

the host

- + the host
@@ -4455,10 +4323,9 @@

detachAll

-

Removes all listeners from the specified event. If the event type + Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will -be removed.

- +be removed.
@@ -4471,8 +4338,7 @@

Parameters:

-

The type, or name of the event

- + The type, or name of the event
@@ -4603,20 +4469,21 @@

fire

-

Fire a custom event by name. The callback functions will be executed + Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the -following parameters.

-

The first argument is the event type, and any additional arguments are +following parameters. + +The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an 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 +in place of the original object. + +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 if the intention is that a bubble target be notified, the event must -be published on this object first.

- +be published on this object first.
@@ -4629,9 +4496,8 @@

Parameters:

-

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

- + The type of the event, or an object that contains +a 'type' property.
@@ -4641,12 +4507,11 @@

Parameters:

-

an arbitrary set of parameters to pass to + an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to -the event facade.

- +the event facade.
@@ -4658,9 +4523,8 @@

Returns:

Boolean: -

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

- + True if the whole lifecycle of the event went through, +false if at any point the event propagation was halted.
@@ -4698,10 +4562,9 @@

get

-

Returns the current value of the attribute. If the attribute + 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.

- +to the 'getter' to obtain the value of the attribute.
@@ -4714,9 +4577,8 @@

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. <code>get("x.y.z")</code>)

- + 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"))
@@ -4728,8 +4590,7 @@

Returns:

Any: -

The value of the attribute

- + The value of the attribute
@@ -4767,8 +4628,7 @@

getAttrs

-

Gets multiple attribute values.

- + Gets multiple attribute values.
@@ -4781,9 +4641,8 @@

Parameters:

-

Optional. An array of attribute names. If omitted, all attribute values are -returned. If set to true, all attributes modified from their initial values are returned.

- + Optional. An array of attribute names. If omitted, all attribute values are +returned. If set to true, all attributes modified from their initial values are returned.
@@ -4795,8 +4654,7 @@

Returns:

Object: -

An object with attribute name/value pairs.

- + An object with attribute name/value pairs.
@@ -4837,9 +4695,8 @@

getEvent

-

Returns the custom event of the provided type has been created, a -falsy value otherwise

- + Returns the custom event of the provided type has been created, a +falsy value otherwise
@@ -4852,8 +4709,7 @@

Parameters:

-

the type, or name of the event

- + the type, or name of the event
@@ -4863,8 +4719,7 @@

Parameters:

-

if true, the type is prefixed already

- + if true, the type is prefixed already
@@ -4876,8 +4731,7 @@

Returns:

CustomEvent: -

the custom event or null

- + the custom event or null
@@ -4909,8 +4763,7 @@

getTargets

-

Returns an array of bubble targets for this object.

- + Returns an array of bubble targets for this object.
@@ -4918,8 +4771,7 @@

getTargets

Returns:

-

EventTarget[]

- + EventTarget[]
@@ -5180,9 +5032,8 @@

init

-

Init lifecycle method, invoked during construction. Sets up attributes -and invokes initializers for the class hierarchy.

- + Init lifecycle method, invoked during construction. Sets up attributes +and invokes initializers for the class hierarchy.
@@ -5195,8 +5046,7 @@

Parameters:

-

Object with configuration property name/value pairs

- + Object with configuration property name/value pairs
@@ -5208,8 +5058,7 @@

Returns:

BaseCore: -

A reference to this object

- + A reference to this object
@@ -5247,26 +5096,25 @@

modifyAttr

-

Updates the configuration of an attribute which has already been added. -<p> + Updates the configuration of an attribute which has already been added. +

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: -</p> -<dl> -<dt>readOnly;</dt> -<dt>writeOnce;</dt> -<dt>broadcast; and</dt> -<dt>getter.</dt> -</dl> -<p> +

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

Note: New attributes cannot be added using this interface. New attributes must be -added using addAttr, or an +added using {{#crossLink "AttributeCore/addAttr:method"}}addAttr{{/crossLink}}, or an appropriate manner for a class which utilises Attributes (e.g. the -ATTRS property in -Base). -</p>

- +{{#crossLink "Base/ATTRS:property"}}ATTRS{{/crossLink}} property in +{{#crossLink "Base"}}Base{{/crossLink}}). +

@@ -5279,8 +5127,7 @@

Parameters:

-

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

- + The name of the attribute whose configuration is to be updated.
@@ -5290,8 +5137,7 @@

Parameters:

-

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

- + An object with configuration property/value pairs, specifying the configuration properties to modify.
@@ -5342,32 +5188,35 @@

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 -receive an EventFacade as the first argument (typically named "e"). + 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 +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 API for all available properties and methods. Subscribers to non-emitFacade events will receive the arguments passed to fire() -after the event name.

-

To subscribe to multiple events at once, pass an object as the first -argument, where the key:value pairs correspond to the eventName:callback.

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

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

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

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

+after the event name. + +To subscribe to multiple events at once, pass an object as the first +argument, where the key:value pairs correspond to the eventName:callback. + + this.on({ + "attrChange" : this._onAttrChange, + "change" : this._onChange + }); + +You can also pass an array of event names as the first argument to +subscribe to all listed events with the same callback. + + this.on([ "change", "attrChange" ], this._onChange); +Returning false from a callback is supported as an alternative to +calling e.preventDefault(); e.stopPropagation();. However, it is +recommended to use the event methods whenever possible.
@@ -5380,8 +5229,7 @@

Parameters:

-

The name of the event

- + The name of the event
@@ -5391,8 +5239,7 @@

Parameters:

-

The callback to execute in response to the event

- + The callback to execute in response to the event
@@ -5403,8 +5250,7 @@

Parameters:

-

Override this object in callback

- + Override this object in callback
@@ -5415,8 +5261,7 @@

Parameters:

-

0..n additional arguments to supply to the subscriber

- + 0..n additional arguments to supply to the subscriber
@@ -5428,9 +5273,8 @@

Returns:

EventHandle: -

A subscription handle capable of detaching that -subscription

- + A subscription handle capable of detaching that + subscription
@@ -5477,10 +5321,9 @@

once

-

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

- + Listen to a custom event hosted by this object one time. +This is the equivalent to on except the +listener is immediatelly detached when it is executed.
@@ -5493,8 +5336,7 @@

Parameters:

-

The name of the event

- + The name of the event
@@ -5504,8 +5346,7 @@

Parameters:

-

The callback to execute in response to the event

- + The callback to execute in response to the event
@@ -5516,8 +5357,7 @@

Parameters:

-

Override this object in callback

- + Override this object in callback
@@ -5528,8 +5368,7 @@

Parameters:

-

0..n additional arguments to supply to the subscriber

- + 0..n additional arguments to supply to the subscriber
@@ -5541,9 +5380,8 @@

Returns:

EventHandle: -

A subscription handle capable of detaching the -subscription

- + A subscription handle capable of detaching the + subscription
@@ -5590,10 +5428,9 @@

onceAfter

-

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

- + Listen to a custom event hosted by this object one time. +This is the equivalent to after except the +listener is immediatelly detached when it is executed.
@@ -5606,8 +5443,7 @@

Parameters:

-

The name of the event

- + The name of the event
@@ -5617,8 +5453,7 @@

Parameters:

-

The callback to execute in response to the event

- + The callback to execute in response to the event
@@ -5629,8 +5464,7 @@

Parameters:

-

Override this object in callback

- + Override this object in callback
@@ -5641,8 +5475,7 @@

Parameters:

-

0..n additional arguments to supply to the subscriber

- + 0..n additional arguments to supply to the subscriber
@@ -5654,9 +5487,8 @@

Returns:

EventHandle: -

A subscription handle capable of detaching that -subscription

- + A subscription handle capable of detaching that + subscription
@@ -5779,12 +5611,11 @@

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 -is configured with a default prefix.

- +is configured with a default prefix.
@@ -5797,8 +5628,7 @@

Parameters:

-

the type

- + the type
@@ -5809,8 +5639,7 @@

Parameters:

-

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

- + The prefix. Defaults to this._yuievt.config.prefix
@@ -5822,14 +5651,11 @@

Returns:

Array: -

an array containing:

-
    -
  • the detach category, if supplied,
    • -
  • the prefixed event type,
    • -
  • whether or not this is an after listener,
    • -
  • the supplied event type
    • -
- + an array containing: + * the detach category, if supplied, + * the prefixed event type, + * whether or not this is an after listener, + * the supplied event type
@@ -5924,10 +5750,9 @@

publish

-

Creates a new custom event of the specified type. If a custom event + Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either -case the custom event is returned.

- +case the custom event is returned.
@@ -5940,8 +5765,7 @@

Parameters:

-

the type, or name of the event

- + the type, or name of the event
@@ -5951,8 +5775,7 @@

Parameters:

-

optional config params. Valid properties are:

- + optional config params. Valid properties are:
@@ -6173,8 +5995,7 @@

removeAttr

-

Removes an attribute from the host object

- + Removes an attribute from the host object
@@ -6187,8 +6008,7 @@

Parameters:

-

The name of the attribute to be removed.

- + The name of the attribute to be removed.
@@ -6228,8 +6048,7 @@

removeTarget

-

Removes a bubble target

- + Removes a bubble target
@@ -6242,8 +6061,7 @@

Parameters:

-

the target to remove

- + the target to remove
@@ -6286,9 +6104,8 @@

reset

-

Resets the attribute (or all attributes) to its initial value, as long as -the attribute is not readOnly, or writeOnce.

- + Resets the attribute (or all attributes) to its initial value, as long as +the attribute is not readOnly, or writeOnce.
@@ -6301,8 +6118,7 @@

Parameters:

-

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

- + Optional. The name of the attribute to reset. If omitted, all attributes are reset.
@@ -6314,8 +6130,7 @@

Returns:

Object: -

A reference to the host object.

- + A reference to the host object.
@@ -6363,8 +6178,7 @@

set

-

Sets the value of an attribute.

- + Sets the value of an attribute.
@@ -6377,10 +6191,9 @@

Parameters:

-

The name of the attribute. If the + 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. <code>set("x.y.z", 5)</code>).

- +to set the value of a property within the object (e.g. set("x.y.z", 5)).
@@ -6390,8 +6203,7 @@

Parameters:

-

The value to set the attribute to.

- + The value to set the attribute to.
@@ -6402,8 +6214,7 @@

Parameters:

-

Optional data providing the circumstances for the change.

- + Optional data providing the circumstances for the change.
@@ -6415,8 +6226,7 @@

Returns:

Object: -

A reference to the host object.

- + A reference to the host object.
@@ -6461,8 +6271,7 @@

setAttrs

-

Sets multiple attribute values.

- + Sets multiple attribute values.
@@ -6475,8 +6284,7 @@

Parameters:

-

An object with attributes name/value pairs.

- + An object with attributes name/value pairs.
@@ -6487,8 +6295,7 @@

Parameters:

-

Optional data providing the circumstances for the change.

- + Optional data providing the circumstances for the change.
@@ -6500,8 +6307,7 @@

Returns:

Object: -

A reference to the host object.

- + A reference to the host object.
@@ -6600,8 +6406,7 @@

subscribe

-

subscribe to an event

- + subscribe to an event
@@ -6634,9 +6439,8 @@

toString

-

Default toString implementation. Provides the constructor NAME -and the instance guid, if set.

- + Default toString implementation. Provides the constructor NAME +and the instance guid, if set.
@@ -6645,8 +6449,7 @@

Returns:

String: -

String representation for this object

- + String representation for this object
@@ -6815,8 +6618,7 @@

unsubscribe

-

detach a listener

- + detach a listener
@@ -6854,10 +6656,9 @@

unsubscribeAll

-

Removes all listeners from the specified event. If the event type + Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will -be removed.

- +be removed.
@@ -6870,8 +6671,7 @@

Parameters:

-

The type, or name of the event

- + The type, or name of the event
@@ -6905,12 +6705,12 @@

_allowAdHocAttrs

-

This property controls whether or not instances of this class should + 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

+ 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)

@@ -7019,8 +6819,7 @@

name

-

The string used to identify the class of this object.

- + The string used to identify the class of this object.
@@ -7398,9 +7197,8 @@

destroyed

-

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

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

Default: false

@@ -7809,9 +7607,8 @@

initialized

-

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

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

Default: false

@@ -8049,18 +7846,17 @@

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 +

+

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

- +

@@ -8073,8 +7869,7 @@

Event Payload:

-

Event object

- + Event object
@@ -8101,17 +7896,16 @@

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 +

+

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

- +

@@ -8124,9 +7918,8 @@

Event Payload:

-

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

- + 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 6333c89b..24ad9c0f 100644 --- a/output/api/classes/DocView.html +++ b/output/api/classes/DocView.html @@ -107,73 +107,73 @@

DocView Class

Constructor

-
-

DocView

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

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

- - - -
- -
- -
- -
-

Parameters:

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

    Meta data to use in this template

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

    The name of the template file to render.

    - -
    - -
    • -
-
- - +
+

DocView

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

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

+ + + +
+ +
+
+ +
+

Parameters:

+ +
    +
  • + data + Object + + +
    +

    Meta data to use in this template

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

    The name of the template file to render.

    + +
    + +
    • +
+ + + +
diff --git a/output/api/classes/Utils.html b/output/api/classes/Utils.html index bef4e0d8..0596a88f 100644 --- a/output/api/classes/Utils.html +++ b/output/api/classes/Utils.html @@ -91,7 +91,7 @@

Utils Class

- Defined in: lib/utils.js:11 + Defined in: lib/utils.js:10
Module: yuidoc @@ -202,7 +202,7 @@

escapeHTML

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

@@ -268,7 +268,7 @@

fixType

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

@@ -334,7 +334,7 @@

getDirs

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

@@ -400,7 +400,7 @@

getLayouts

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

@@ -467,7 +467,7 @@

getPage

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

@@ -533,7 +533,7 @@

getPages

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

@@ -601,7 +601,7 @@

getPartials

Defined in - lib/utils.js:126 + lib/utils.js:125

@@ -665,7 +665,7 @@

getProjectData

Defined in - lib/utils.js:226 + lib/utils.js:225

@@ -726,7 +726,7 @@

prepare

Defined in - lib/utils.js:140 + lib/utils.js:139

@@ -827,7 +827,7 @@

unindent

Defined in - lib/utils.js:44 + lib/utils.js:43

@@ -896,7 +896,7 @@

validatePaths

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

@@ -965,7 +965,7 @@

webpath

Defined in - lib/utils.js:476 + lib/utils.js:475

diff --git a/output/api/classes/YUIDoc.html b/output/api/classes/YUIDoc.html index 5d02cb84..4bb77e4d 100644 --- a/output/api/classes/YUIDoc.html +++ b/output/api/classes/YUIDoc.html @@ -113,59 +113,59 @@

YUIDoc Class

Constructor

-
-

YUIDoc

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

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

- - - -
- -
- -
- -
-

Parameters:

- -
    -
  • - config - Object - - -
    -

    The config object

    - -
    - -
    • -
-
- - +
+

YUIDoc

+ +
+ (
    +
  • + config +
    • +
) +
+ + + + + + + + +
+

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

+ + + +
+ +
+
+ +
+

Parameters:

+ +
    +
  • + config + Object + + +
    +

    The config object

    + +
    + +
    • +
+ + + +
diff --git a/output/api/data.json b/output/api/data.json index c84ea301..f8cc47c9 100644 --- a/output/api/data.json +++ b/output/api/data.json @@ -307,7 +307,7 @@ "module": "yuidoc", "namespace": "", "file": "lib/utils.js", - "line": 11, + "line": 10, "description": "Utilities Class" }, "YUIDoc": { @@ -345,7 +345,7 @@ }, { "file": "lib/builder.js", - "line": 120, + "line": 123, "description": "Register a `Y.Handlebars` helper method", "itemtype": "method", "name": "_addHelpers", @@ -361,7 +361,7 @@ }, { "file": "lib/builder.js", - "line": 137, + "line": 140, "description": "Wrapper around the Markdown parser so it can be normalized or even side stepped", "itemtype": "method", "name": "markdown", @@ -383,7 +383,7 @@ }, { "file": "lib/builder.js", - "line": 162, + "line": 165, "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": 269, + "line": 272, "description": "List of native types to cross link to MDN", "itemtype": "property", "name": "NATIVES", @@ -424,7 +424,7 @@ }, { "file": "lib/builder.js", - "line": 308, + "line": 311, "description": "Function to link an external type uses `NATIVES` object", "itemtype": "method", "name": "NATIVES_LINKER", @@ -446,7 +446,7 @@ }, { "file": "lib/builder.js", - "line": 322, + "line": 325, "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": 370, + "line": 373, "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": 445, + "line": 448, "description": "File counter", "itemtype": "property", "name": "files", @@ -484,7 +484,7 @@ }, { "file": "lib/builder.js", - "line": 451, + "line": 454, "description": "Holder for project meta data", "itemtype": "property", "name": "_meta", @@ -496,7 +496,7 @@ }, { "file": "lib/builder.js", - "line": 458, + "line": 461, "description": "Prep the meta data to be fed to Selleck", "itemtype": "method", "name": "getProjectMeta", @@ -509,7 +509,7 @@ }, { "file": "lib/builder.js", - "line": 501, + "line": 504, "description": "Populate the meta data for classes", "itemtype": "method", "name": "populateClasses", @@ -529,7 +529,7 @@ }, { "file": "lib/builder.js", - "line": 525, + "line": 528, "description": "Populate the meta data for modules", "itemtype": "method", "name": "populateModules", @@ -549,7 +549,7 @@ }, { "file": "lib/builder.js", - "line": 571, + "line": 574, "description": "Populate the meta data for files", "itemtype": "method", "name": "populateFiles", @@ -569,7 +569,7 @@ }, { "file": "lib/builder.js", - "line": 628, + "line": 631, "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": 644, + "line": 647, "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": 705, + "line": 707, "description": "Makes the default directories needed", "itemtype": "method", "name": "makeDirs", @@ -625,7 +625,7 @@ }, { "file": "lib/builder.js", - "line": 758, + "line": 760, "description": "Parses `
` tags and adds the __prettyprint__ `className` to them",
             "itemtype": "method",
             "name": "_parseCode",
@@ -647,7 +647,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 771,
+            "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",
@@ -669,7 +669,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 790,
+            "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",
@@ -721,7 +721,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 846,
+            "line": 848,
             "description": "Render the index file",
             "itemtype": "method",
             "name": "renderIndex",
@@ -749,7 +749,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 871,
+            "line": 873,
             "description": "Generates the index.html file",
             "itemtype": "method",
             "name": "writeIndex",
@@ -777,7 +777,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 897,
+            "line": 899,
             "description": "Render a module",
             "itemtype": "method",
             "name": "renderModule",
@@ -805,7 +805,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 981,
+            "line": 983,
             "description": "Generates the module files under \"out\"/modules/",
             "itemtype": "method",
             "name": "writeModules",
@@ -833,7 +833,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1024,
+            "line": 1026,
             "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": 1041,
+            "line": 1043,
             "description": "Counter for stepping into merges",
             "access": "private",
             "tagname": "",
@@ -869,7 +869,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1048,
+            "line": 1050,
             "description": "Merge superclass data into a child class",
             "itemtype": "method",
             "name": "mergeExtends",
@@ -895,7 +895,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1100,
+            "line": 1102,
             "description": "Render the class file",
             "itemtype": "method",
             "name": "renderClass",
@@ -923,7 +923,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1388,
+            "line": 1389,
             "description": "Generates the class files under \"out\"/classes/",
             "itemtype": "method",
             "name": "writeClasses",
@@ -951,7 +951,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1431,
+            "line": 1432,
             "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": 1454,
+            "line": 1455,
             "description": "Generates the syntax files under `\"out\"/files/`",
             "itemtype": "method",
             "name": "writeFiles",
@@ -1004,7 +1004,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1504,
+            "line": 1505,
             "description": "Render the source file",
             "itemtype": "method",
             "name": "renderFile",
@@ -1032,7 +1032,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1558,
+            "line": 1559,
             "description": "Write the API meta data used for the AutoComplete widget",
             "itemtype": "method",
             "name": "writeAPIMeta",
@@ -1049,7 +1049,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1571,
+            "line": 1572,
             "description": "Render the API meta and return the JavaScript",
             "itemtype": "method",
             "name": "renderAPIMeta",
@@ -1073,7 +1073,7 @@
         },
         {
             "file": "lib/builder.js",
-            "line": 1604,
+            "line": 1605,
             "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": 1617,
+            "line": 1618,
             "description": "Compiles the templates from the meta-data provided by DocParser",
             "itemtype": "method",
             "name": "compile",
@@ -2090,7 +2090,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 31,
+            "line": 30,
             "description": "Escapes HTML characters in _html_.",
             "itemtype": "method",
             "name": "escapeHTML",
@@ -2110,7 +2110,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 44,
+            "line": 43,
             "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.",
             "itemtype": "method",
             "name": "unindent",
@@ -2132,7 +2132,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 65,
+            "line": 64,
             "description": "Like `getPages()`, but returns only the files under the `layout/` subdirectory\nof the specified _dir_.",
             "itemtype": "method",
             "name": "getLayouts",
@@ -2152,7 +2152,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 78,
+            "line": 77,
             "description": "Loads and returns the content of the specified page file.",
             "itemtype": "method",
             "name": "getPage",
@@ -2172,7 +2172,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 93,
+            "line": 92,
             "description": "Loads pages (files with a `.handlebars` extension) in the specified directory and\nreturns an object containing a mapping of page names (the part of the filename)\npreceding the `.handlebars` extension) to page content.",
             "itemtype": "method",
             "name": "getPages",
@@ -2192,7 +2192,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 126,
+            "line": 125,
             "description": "Like `getPages()`, but returns only the files under the `partial/` subdirectory\nof the specified _dir_.",
             "itemtype": "method",
             "name": "getPartials",
@@ -2212,7 +2212,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 140,
+            "line": 139,
             "description": "Mix/merge/munge data into the template.",
             "itemtype": "method",
             "name": "prepare",
@@ -2250,7 +2250,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 226,
+            "line": 225,
             "description": "Walk the directory tree to locate the yuidoc.json file.",
             "itemtype": "method",
             "name": "getProjectData",
@@ -2268,7 +2268,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 340,
+            "line": 339,
             "description": "Walks the tree from this dir and returns all the subdirs",
             "itemtype": "method",
             "name": "getDirs",
@@ -2288,7 +2288,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 366,
+            "line": 365,
             "description": "Make sure all the paths passed are directories and that they are not in the ignore list.",
             "itemtype": "method",
             "name": "validatePaths",
@@ -2311,7 +2311,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 454,
+            "line": 453,
             "description": "Takes a type string and converts it to a \"First letter upper cased\" type. e.g. `(string -> String, object -> Object)`",
             "itemtype": "method",
             "name": "fixType",
@@ -2331,7 +2331,7 @@
         },
         {
             "file": "lib/utils.js",
-            "line": 476,
+            "line": 475,
             "description": "Produces a normalized web path by joining all the parts and normalizing the\nfilesystem-like path into web compatible url.\nSupports relative and absolute paths.\nCourtesy of [Mojito's utils](https://github.com/yahoo/mojito/)",
             "itemtype": "method",
             "name": "webpath",
diff --git a/output/api/files/lib_builder.js.html b/output/api/files/lib_builder.js.html
index d94f1e63..3d61a60a 100644
--- a/output/api/files/lib_builder.js.html
+++ b/output/api/files/lib_builder.js.html
@@ -109,7 +109,10 @@ 
File: lib/builder.js

 */
 
 YUI.add('doc-builder', function (Y) {
-    /*jshint onevar:false */
+    var defaultMarkdownOption = {
+        html: true,
+        linkify: true
+    };
 
     var fixType = Y.Lang.fixType,
         print = function (items) {
@@ -146,7 +149,7 @@ 
File: lib/builder.js

         if (options.themedir) {
             themeDir = options.themedir;
         }
-        this.md = new MarkdownIt(options.markdown);
+        this.md = new MarkdownIt(Y.merge(defaultMarkdownOption, options.markdown));
         this.data = data;
         Y.log('Building..', 'info', 'builder');
         this.files = 0;
@@ -757,11 +760,10 @@ 
File: lib/builder.js

                         }
                         if (!a.description) {
                             a.description = ' ';
-                        } else {
-                            //a.description = markdown(a.description, true, self.defaultTags);
+                        } else if (!o.extended_from) {
                             a.description = self.markdown(a.description);
                         }
-                        if (a.example) {
+                        if (a.example && !o.extended_from) {
                             a.example = self.markdown(a.example);
                         }
                         a = self.addFoundAt(a);
@@ -784,12 +786,12 @@ 
File: lib/builder.js

                             if (v.forEach || (v instanceof Object)) {
                                 o[k1][k] = self.augmentData(v);
                             } else {
-                                o[k1][k] = self.markdown(v);
+                                o[k1][k] = o.extended_from ? v : self.markdown(v);
                             }
                         }
                     });
                 } else if (k1 === 'description' || k1 === 'example') {
-                    o[k1] = self.markdown(i);
+                    o[k1] = o.extended_from ? i : self.markdown(i);
                 }
             });
             return o;
@@ -1303,7 +1305,6 @@ 
File: lib/builder.js

                                 i.paramsList.push(name);
                             });
                         }
-                        //i.methodDescription = self._parseCode(markdown(i.description || ''));
                         i.methodDescription = self._parseCode(i.description);
                         if (i.example && i.example.length) {
                             if (i.example.forEach) {
@@ -1312,7 +1313,7 @@ 
File: lib/builder.js

                                     e += self._parseCode(self.markdown(v));
                                 });
                                 i.example = e;
-                            } else {
+                            } else if (!i.extended_from) {
                                 i.example = self._parseCode(self.markdown(i.example));
                             }
                         }
diff --git a/output/api/files/lib_index.js.html b/output/api/files/lib_index.js.html
index e0d9d7b4..a09551b0 100644
--- a/output/api/files/lib_index.js.html
+++ b/output/api/files/lib_index.js.html
@@ -128,6 +128,17 @@ 
File: lib/index.js

     fs = require('graceful-fs'),
     metaPath = path.join(__dirname, '../', 'package.json');
 
+function log (message, level) {
+    if (!message || !level || typeof console[level] !== 'function') {
+        return;
+    }
+
+    if (typeof message === 'object') {
+        message = JSON.stringify(message);
+    }
+
+    console[level]('%s: %s', level, message);
+}
 
 process.on('uncaughtException', function (msg) {
     var meta = JSON.parse(fs.readFileSync(metaPath)),
@@ -136,6 +147,7 @@ 
File: lib/index.js

 
     inst.applyConfig({
         debug: true,
+        logFn: log,
         useColor: useColor
     });
 
@@ -192,6 +204,7 @@ 
File: lib/index.js

         attribute: true,
         handlebars: true
     },
+    logFn: log,
     useSync: true
 }).use('utils', 'docparser', 'yuidoc', 'doc-builder', 'docview', 'files', 'help', 'options', 'server', 'project');
 
diff --git a/output/api/files/lib_options.js.html b/output/api/files/lib_options.js.html
index 3cd77ead..856fc20b 100644
--- a/output/api/files/lib_options.js.html
+++ b/output/api/files/lib_options.js.html
@@ -112,8 +112,6 @@ 
File: lib/options.js

      * @return {Object} The config object
      */
     Y.Options = function (args) {
-        /*jshint onevar:false */
-
         var options = {
             port: 3000,
             nocode: false
diff --git a/output/api/files/lib_project.js.html b/output/api/files/lib_project.js.html
index 521d82e0..2f37f1bd 100644
--- a/output/api/files/lib_project.js.html
+++ b/output/api/files/lib_project.js.html
@@ -145,7 +145,6 @@ 
File: lib/project.js

             }
 
             if (typeof options.tabtospace === 'number') {
-                /*jshint onevar:false */
                 options.tabspace = '';
                 for (var s = 0; s < options.tabtospace; s++) {
                     options.tabspace += ' ';
diff --git a/output/api/files/lib_utils.js.html b/output/api/files/lib_utils.js.html
index 5c6da9d6..17568645 100644
--- a/output/api/files/lib_utils.js.html
+++ b/output/api/files/lib_utils.js.html
@@ -95,7 +95,6 @@ 
File: lib/utils.js

  * Code licensed under the BSD License:
  * https://github.com/yui/yuidoc/blob/master/LICENSE
  */
-/*jshint onevar:false */
 var path = require('path'),
     minimatch = require('minimatch'),
     fs = require('graceful-fs');
diff --git a/output/index.html b/output/index.html
index 6d557e90..251f50da 100644
--- a/output/index.html
+++ b/output/index.html
@@ -24,7 +24,7 @@ 

         

             

-                
Welcome to YUIDoc 0.6.0!

+                
Welcome to YUIDoc 0.7.0!

 
 

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