Re: What do capture in API docs

It might be worth noting which of these are picked up by the parser, and
which need to be done using comments. I think a lot of people might be
surprised by how much of this information is actually discovered by the
parser.

-Neil

> Hey there.  I'm trying to figure out a proposal to put to the group
> tomorrow for "what should we be capturing in the API reference
> docs".  I've come up with a list below.  What am I missing?
>
> Note that I'm not asking "where should these be doc'd" but rather
> "what do we need to cover".  Please restrict replies to the "what"
> question, not the "where".
>
> thanks
> Owen
>
>
> * Modules:
>       - defined in file(s)
>       - status (deprecated, experimental)
>       - summary
>       - description/usage
>       - examples
>       - see also
>       - objects/classes       [see below]
>
> * Objectes/"Classes":
>       - defined in file(s)
>       - status (deprecated, experimental)
>       - summary
>       - description/usage
>       - examples
>       - see also
>       - instance methods      [see below], including "super" methods
>       - instance properties   [see below], including "super" properties
>       - static methods?
>       - static properties?
>       - constants?
>       - constructor(s)
>       - prototype chain
>
>
> * Function/Methods:
>       - defined in file
>       - defined in object/"class"
>       - status (deprecated, experimental)
>       - privacy (public, protected, private)
>       - summary
>       - description/usage
>       - examples
>       - see also
>       - arguments [see below]
>       - return type(s)
>       - source
>
> * Function arguments:
>       - type(s), including enumerated values
>       - optional?
>       - default value
>       - summary
>       - see also
>
> * Properties
>       - defined in file
>       - defined in object/"class"
>       - status (deprecated, experimental)
>       - privacy (public, protected, private)
>       - type(s), including enumerated values
>       - description
>       - examples
>       - see also
>
> _______________________________________________
> dojo-contributors mailing list
> dojo-contributors@xxxxxxxxxxxxxxx
> http://dojotoolkit.org/mailman/listinfo/dojo-contributors
>