search

mgalloy / idldoc

Documenting IDL code
Other
21 stars 13 forks source link

Directory level comments #27

Closed mgalloy closed 11 years ago

mgalloy commented 11 years ago

There should be a mechanism to allow "directory level" comments. In version pre-3.0, a file named directory-overview in the directory contained the directory overview comments, but the feature was broken in several of the releases. Some file and routine level tags would make sense of the directory level, such as copyright, history, author.

mgalloy commented 11 years ago

I think there should be an .idldoc file allowed in each directory that would contain overview text and possibly some other flags such as an "ignore this directory" flag.

mgalloy commented 11 years ago

r603 adds .idldoc files in each directory. Right now comments for these files are added to the directory overview, but no tags are supported. Tags needed: private, hidden, copyright, history, and author.

mgalloy commented 11 years ago

r606 adds private and hidden tags to the rst and idldoc format styles.

mgalloy commented 11 years ago

r607 adds author, copyright, and history tags for the rst and idldoc format styles. r608 fixes up the LaTeX templates for handling these tags.

Resolving this ticket as done.