logo       

What do capture in API docs: msg#00519

web.dojo.devel

Subject: What do capture in API docs


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


<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise