Documentation comments start with
/** and end with
**/. Each new line starts with
/** ... * ... **/
The opening line of a comment is reserved for tags. Tags are optional. Tags are separated by a comma followed by optional whitespace(s) (
,). They can be either a tag name or a key / value pair separated by a colon and optional whitespace(s) (
tagName ': ' tagValue [', ' tagName ': ' tagValue]...
Currently supported tags are:
section: <name>- description belongs to specified section
alias of: <name>- entity is another name for entity
related to: <name>- description is related to entity
read-only- entity is read-only
internal- entity is meant to be private
chainable- method can be chained, i.e. the return value is the same object to which method belongs. E.g. $(...).on(...).on(...)
deprecated- entity is considered deprecated. Deprecation tag in addition have the following flavors:
deprecated: <from>- deprecated starting from version
deprecated: <from>..<out>- deprecated starting from version
fromand will be removed by version
/** deprecated: 1.0..2.0, section: DOM, alias of: Element#descendantOf, chainable * Element#childOf(@element, className) -> Element * * ... **/
The lines directly following tags are reserved for the EBNF description of the documented object. Typically, there's only one EBNF per documented object:
/** * Element#down(@element[, cssSelector][, index]) -> Element | null * * ... **/
However, methods, functions, etc. may have several signatures, hence may require more than one description line, in which case description lines directly follow each other:
/** * Element#writeAttribute(@element, attribute[, value = true]) -> Element * Element#writeAttribute(@element, attributes) -> Element * * ... **/
For all methods, functions, etc. parentheses around the arguments are required even if no arguments are present. The syntax for arguments is as follows:
/** * Event.stop(event) -> Event * * ... **/
Optional arguments are surrounded by squared brackets (
/** * String#evalJSON([sanitize]) -> Object | Array * * ... **/
A default value may be indicated using the equal sign (
/** * String#evalJSON([sanitize = false]) -> Object | Array * * ... **/
Note that the argument separating comas belong inside the brackets.
/** * Event.findElement(event[, cssSelector]) -> Element | null * * ... **/
Arguments can be described below the EBNF description using the following syntax:
- argumentName (acceptedType | otherAcceptedType | ...): description.
Supported EBNF types
BIG FAT WARNING: EBNF descriptions must be separated by an empty comment line from the rest of description:
/** * String#evalJSON([sanitize = false]) -> Object | Array * * Here goes markdown for String#evalJSON description. **/ /** * Event.findElement(event[, cssSelector]) -> Element | null * - event (Event): a native Event instance * - cssSelector (String): a optional CSS selector which uses * the same syntax found in regular CSS. * * Regular method markdown goes here. **/
Descriptions are parsed as markdown markup, with github-style extension for code blocks
/** * Ajax * * ... **/ /** * Prototype.Browser * * ... **/
Classes require a
/** * class Ajax.Base * * ... **/
Sub-classes can indicate their parent just like in the Ruby syntax:
/** * class Ajax.Request < Ajax.Base * * ... **/
Ajax.Base is the parent class and
Ajax.Request the subclass.
Included mixins are indicated like so:
/** * class CustomHash * includes Enumerable, Comparable * * ... **/
Mixins are indicated by a
/** * mixin Enumerable * * ... **/
Constructors require the
new prefix and their arguments.
/** * new Element(tagName[, attributes]) * * ... **/ /** * new Foobar() * * ... **/
Class methods are identified by a dot (
/** * Array.from([iterable]) -> Array * * ... **/
Instance methods are identified by the hash symbol (
/** * Array#first() -> Array element * * ... **/
Utilities are global functions starting with a dollar-sign (
/** * $w(string) -> Array * * ... **/
Methodized methods are methods which are both available as a class method and an instance method, in which case the first argument becomes the instance object itself. For example, all of
Element's instance methods are methodized and thus also available as class methods of
Element. Methodized methods are indicated by prefixing their first argument with the
/** * Element#hide(@element) -> Element * * ... **/
Class properties are identified by a dot (
/** * Ajax.Responders.responders -> Array * * ... **/
Instance properties are identified by the hash symbol (
/** * Ajax.Response#responseText -> String * * ... **/
Constant must have their value specified using the equal sign (
/** * Prototype.JSONFilter = /^\/\*-secure-([\s\S]*)\*\/\s*$/ * * ... **/
Events are identified by
/** * Features@head(request, socket, head) * * ... **/
Sections are grouped parts of documentation. They don't add to element hierarchy, but just help to organize documentation.
/** * == Section Name == * * Describe this section here. **/
Short links help to quickly refer some element. Supported are two flavors:
[[Method.Name]]- renders to
[[Method.Name TEXT]]- renders to
Difference from PDoc
- Descriptions should be ALWAYS separated by empty line from the upper string (signature, section, tags...).
deprecatedcan have options.
- Additional tags - read-only, internal, chainable.
- Events support.