Here you can search through the pages of this Namespace, their attachments and the files uploaded to the system.
Note: the results will only display the items you have permissions to read.
[...] Sys.Net.WebRequestExecutor = function Sys$Net$WebRequestExecutor() {
/// ...
}
After registering the namespace Sys.Net , the type Sys.Net.WebRequestExecutor is considered as type WebRequestExecutor , living in the namespace Sys.Net . In ECMADoc, every type discovered in the global (document) scope will be assigned a namespace. That is, all types in ECMADoc have a namespace. The default namespace [...]
Registers a namespace with the parser. Example
/**
* @document
* @namespace adventureworks Main AdventureWorks namespace.
* @namespace adventureworks.utils Contains the AdventureWorks' utility classes.
* This part is the extended description of the adventureworks.utils namespace.
*/ Description
Because ECMAScript 3 and lower doesn't provide built-in support for specifying namespaces through the package keyword and related constructs, this token [...]
[...] documentation generation into an automated build process, where the latest sources and the latest the ECMADoc project can be checked out from the source control and the documentation generated without requiring any prior modifications. $Resource path ECMADoc provides a number of base files that can be included in the documentation. These files are delivered together with other ECMADoc resources in the Resources folder. Because the location of this folder cannot reliably be referred to with a relative path, the [...]
A typical ECMADoc documentation comments look similar like this:
/**
* Gets a new array consisting of a combination of two or more arrays.
* @syntax array1.concat([item1, [item2[, ...[, itemN]]]])
* @arguments {Object} [0-n] Additional items to add to the end of this array. Optional.
* @return {Array} The new combined array.
*/
Array.prototype.concat = function ()
{
}
What distinguishes an ECMADoc comment from regular comments is the second star (*) following the opening slash/star (/*) sequence:
/**
* (the ECMADoc [...]
Signifies a document comment. Example
/**
* @document
* @namespace adventureworks
* @namespace adventureworks.utils
*/ Description
The sole purpose of the document tag is to signify that a comment block applies to the document itself. One use of this documentation block is to provide a placeholder for adding @namespace tokens to register namespaces. The document token otherwise acts just like other EcmaDoc comments, so any lines of text from the beginning of the comment [...]
Tokens are one or more lines within an ECMADoc comment that begin with the name of the token, prefixed with an 'at' (@) symbol. Each token is assigned a token handler in the parser configuration file , which does different things for different tokens. The tokens currently supported by ECMADoc are: Token Summary @document Signifies a document comment. [...]
[...] JavaScript 1.x) are supported, but future releases will add support for later ECMAScript versions as well. ECMADoc parses one or more source files specified in a project and generates API documentation based on the code structure and comments written in a specific format. The format is similar or equivalent to JavaDoc/JsDoc format. The documentation is divided in following sections and articles: Documenting code Writing documentation Tokens Using ECMADoc [...]
On any place a type is used, ECMADoc will attempt to resolve it, and if successful the type name will in the generated HTML documentation become a link to that type. Examples of valid type expressions: Object Object.toString Aeon.Controls.Slider Aeon.Controls.Slider.getValue Resolving of types is context aware, that is, when ECMADoc is resolving a type string it does it by searching the match beginning from the context in which the type expression was found. So when a value [...]
[...] match="{?(?'type'[\w\.\$]+)}?(?:\s+(?'description'[\s\S]*))? Expression configuration All regular expressions in use by ECMADoc are defined in this configuration file. Each expression defines its name, the name of the delegate method that handles it, a simple description of what it does and the regular expression associated with it. expression element Required. This is the root node that contains all other content.
<expression name="Function" handler="FunctionHandler" description="matches any type of function expression">
<rxp><![CDATA[
(?:\[comment(?'Comment'\d+)\]\s*)?(?:(?'VarDecl'var)\s*)?#
[...]
[...] configuration files specify all options related to parsing files from, and producing documentation of ECMADoc projects. The configuration files are XML files, and a schema file is provided that you can use to create and validate new configuration files if you are writing them by hand. Example This example shows configuration of a project called 'Aeon'.
<?xml version="1.0" encoding="utf-8"?>
<project name="Aeon" xmlns="http://www.cycle99.com/tools/ecmadoc">
<output path="aeon" fileExtension=".html" groupBy="type">
<theme>default</theme>
[...]
[...] class can have multiple parent classes), you would want to set this option to True . This will enable ECMADoc to store multiple parents per class and will affect how this will be appear in the output HTML. Output Output path Specifies the folder in which the generated documentation will be saved. File extension Specifies the extension that the generated files should have. Typically this will be '.htm' or '.html'. Output members on one page This option controls whether the members of a type should appear on the same page as their containing type, or on separate pages. [...]
[...] involves only specifying the path to the project file. The syntax for the command-line client is:
EcmaDoc.Console [project_file]
For instance, if you have a project file at d:\projects\p1\p1.xml, the command line would simply be:
EcmaDoc.Console [...]
[...] documentation, these base files can be used. Base file are located in the Resources/Base directory of the ECMADoc. Array class, in a project that doesn't include the base file
In the example below, one of the files in the project extends the built-in Array class with an additional method 'each'. However, since there is no other information about the array, the HTML output that ECMADoc [...]
[...] for instance) doesn't provide formal support for classes. Regular functions carry the whole burden. ECMADoc will consider as class any function that has any prototype or static members (for more information about visibility see the visibility page. To make ECMADoc [...]
For most types, ECMADoc distinguishes between these four visibility types: Prototype Instance Static Private Prototype visibility These are any members assigned to an object's prototype .
Array. prototype .contains = function Array$contains(value) { ... }
Instance visibility These are the members declared on the type itself through the use of keyword this .
this .source = eventSource;
Static visibility Static are the members assigned to the type itself, and that can therefore be accessed from scope directly.
Object.serialize = function Object$serialize(object) [...]
This token is an alias for @namespace token. See also All tokens [...]
[...] keyword and related constructs, this token is used to mark designated functions as classes. Note that ECMADoc will automatically consider as classes any functions that define custom prototype members. In case ECMADoc [...]
[...] || document);
return result;
} Description
To link to an external URL, use the @link token. ECMADoc will then use generate this link in the 'See [...]
[...] =
{
} Description
To link to another type in the output documentation, use the @see token. ECMADoc will try to resolve the specified string from [...]
[...] of @example tokens. Example blocks will be interpreted and syntax-highlighted as JavaScript. To make ECMADoc interpret an example as another language, [...]
ECMADoc always operates on projects. Projects define [...]
[...] Because of this, many developers and JavaScript frameworks implement custom ways of working with events. ECMADoc provides the @event token as an easy way to [...]
[...] start of the Array. Optional.
*/
Array.prototype.unshift = function ()
{
} Description
ECMADoc will generate the function synopsis automatically, [...]
[...] keyword and related constructs, this token is used to mark designated members as private . Note that ECMADoc will automatically consider as private any [...]