search

mgalloy / idldoc

Documenting IDL code
Other
21 stars 13 forks source link

Define overview style for IDL format #30

Open mgalloy opened 12 years ago

mgalloy commented 12 years ago

Overview files in the IDL format should look like:

Overview comments.

DIRECTORIES:
  ./: Description goes here. This must be followed by a blank line.

  collection/: Description goes here. Note that the description can flow
               onto following lines. It is the blank line that delimits
               directories.
mgalloy commented 12 years ago

This should also include the directory overview as well.