search

mgalloy / idldoc

Documenting IDL code
Other
21 stars 13 forks source link

full documentation #32

Closed mgalloy closed 11 years ago

mgalloy commented 11 years ago

It would be useful to document what is required to reach "full documentation" status (as used to pull information into the warnings page). It would also be useful to be able to define or reduce the requirements for full documentation if it is more than just documenting all fields, param, keywords (i.e. the obvious required elements).

mgalloy commented 11 years ago

Added to help page in r449: To be fully documented, a routine must have routine comments, document each parameter/keyword, and, if a function, document its return value.