yuidoc-asp
Version:
YUIDoc, YUI's JavaScript Documentation engine tweaked to work with VB/VBScript comments.
278 lines (229 loc) • 6.6 kB
JavaScript
/**
* The test project
* @project tester
* @title The Tester
* @icon http://a.img
* @url http://one.url
* @url http://two.url
* @author admo
* @contributor davglass
* @contributor entropy
*/
/**
* The module
* @module mymodule
* @category one,two
* @category three
* @requires one
* @requires two
* @uses three
* @uses four
*/
/**
* The submodule
* @submodule mysubmodule
* @category three,four
*/
/**
* The class def
* @class myclass
* @constructor
*/
/**
* test optional
* @method testoptional
* @param notype my desc
* @param {int} namesecond my desc
* @param namefirst {string} my desc
* @param [optionalvar] {bool} my desc
* @param {string} [optionalDefault1="defaultVal"] my desc
* @param {string} [optionalDefault2="defaultVal1 defaultVal2"] my desc
* @evil
* @injects {HTML} uses a string parameter to populate innerHTML
* @returns something without a type
* @throws throw error without a type
* @example
* This is code
* @example
* var = 'This is more code';
* document.title = 'Test This';
*/
/**
* test object param
* @method testobjectparam
* @param {object} anobject the object
* @param {string} anobject.prop1 prop1
* @param {bool} anobject.prop2 prop2
* @return {string} something with a type
* @throws {error} error with a type
*/
/**
* test 0..n param
* @method test0ton
* @param {string} [optionalandmultiple]* my desc
* @returns something without a type
* @throws throw error without a type
*/
/**
* test 1..n param
* @method test1ton
* @param {string} multiple* my desc
* @returns something without a type
* @throws throw error without a type
*/
/**
test alternative 1..n param with ...args
@method testrestparam1n
@param {String} ...multiple my desc
@returns something without a type
@throws throw error without a type
**/
/**
test alternative 0..n param with ...args
@method testrestparam0n
@param {String} [...multiple] my desc
@returns something without a type
@throws throw error without a type
**/
/**
Test newlines before descriptions.
@method testNewlineBeforeDescription
@param {String} foo
This parameter is foo.
@param {String} bar
This parameter is bar.
It does useful things.
@return {Boolean}
Sometimes true, sometimes false.
Nobody knows!
@throws {Error}
Throws an error.
Catch me.
**/
/**
'' Test ASP comment syntax.
''
'' @method testAspCommentSyntax
''
' @param {String} foo single apostrophe.
'
'* @param {String} bar single apostrophe and asterisk.
'
' * @param {String} bas single apostrophe, whitespace, and asterisk.
'
'' @param {String} bat double apostrophe.
''
''* @param {String} bau double apostrophe and asterisk.
''
'' * @param {String} bav double apostrophe, whitespace, and asterisk.
''
'' @return {Boolean} true when test is awesome
''**/
/**
* Testing really long param description paring
* @method reallyLongParamDesc
* @param {Object} config Object with configuration property name/value pairs. The object can be
* used to provide default values for the objects published attributes.
*
* <p>
* The config object can also contain the following non-attribute properties, providing a convenient
* way to configure events listeners and plugins for the instance, as part of the constructor call:
* </p>
*
* <dl>
* <dt>on</dt>
* <dd>An event name to listener function map, to register event listeners for the "on" moment of the event. A constructor convenience property for the <a href="Base.html#method_on">on</a> method.</dd>
* <dt>after</dt>
* <dd>An event name to listener function map, to register event listeners for the "after" moment of the event. A constructor convenience property for the <a href="Base.html#method_after">after</a> method.</dd>
* <dt>bubbleTargets</dt>
* <dd>An object, or array of objects, to register as bubble targets for bubbled events fired by this instance. A constructor convenience property for the <a href="EventTarget.html#method_addTarget">addTarget</a> method.</dd>
* <dt>plugins</dt>
* <dd>A plugin, or array of plugins to be plugged into the instance (see PluginHost's plug method for signature details). A constructor convenience property for the <a href="Plugin.Host.html#method_plug">plug</a> method.</dd>
* </dl>
*
*/
/**
This is the description
@method foo
@example
var email = "lsmith@foo-truncated-here.com"
**/
/**
@method foo2
@example
@media screen and (max-width: 767px) {
}
*/
/**
Other Class
@class OtherClass
@extensionfor myclass
*/
/**
Other Class 2
@class OtherClass2
@extension_for myclass
*/
/**
Default options to use for all transactions.
@static
@protected
@property {Object} options
@property {Object} [options.attributes] HTML attribute name/value pairs that
should be added to inserted nodes.
@property {Boolean} [options.autopurge=false] Whether or not to automatically
purge inserted nodes after the purge threshold is reached.
@property {Document} [options.doc] Document into which nodes should be inserted.
@property {Number} [options.pollInterval=50] Polling interval (in milliseconds)
for detecting CSS load completion in browsers that don't support the `load`
event on `<link>` nodes.
**/
/**
This is a test of CASE TaGs
@MeThod testMethod
@ParaM {String} foo Foo description
*/
/**
This is an optional attribute
@attribute optionalAttr
@optional
*/
/**
This is a required attribute
@attribute requiredAttr
@required
*/
/**
crash test method
@method crashTest
@params {String} foo The string to crash the parser
*/
/**
* @event changeWithOptional
* @param ev {EventFacade} containing:
* @param [ev.name] {String} Name of the field changed
*/
/**
This method fires {{#crossLink "OtherClass2/changeWithOptional:event"}}{{/crossLink}}
@method crossedEvent
*/
/**
This method has attr {{#crossLink "OtherClass2/requiredAttr:attribute"}}{{/crossLink}}
@method crossedAttr
*/
/**
This method has attr {{#crossLink "OtherClass2/optionalAttr:attr"}}{{/crossLink}}
@method crossOptAttr
*/
/**
Test `\{{foobar\}}` `\{{barfoo\}}`
@method hbHelper1
*/
/**
Test `\{{foobar2\}}` `\{{barfoo2\}}`
@method hbHelper2
*/
/**
Test `\{{foobar3\}}` `\{{barfoo3\}}`
@method hbHelper3
*/