Ticket #33 (closed enhancement: fixed)

Opened 4 years ago

Last modified 4 years ago

full documentation

Reported by: jhood Owned by: mgalloy
Priority: minor Milestone: IDLdoc 3.1
Component: core Version:
Keywords: Cc:

Description

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).

Change History

Changed 4 years ago by mgalloy

  • status changed from new to closed
  • resolution set to fixed

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.

Note: See TracTickets for help on using tickets.