Ticket #28 (closed enhancement: fixed)

Opened 4 years ago

Last modified 3 years ago

Directory level comments

Reported by: mgalloy Owned by: mgalloy
Priority: major Milestone: IDLdoc 3.3
Component: parsing Version: 3.2
Keywords: Cc:

Description

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.

Change History

Changed 4 years ago by mgalloy

  • status changed from new to assigned
  • milestone changed from IDLdoc 3.1 to IDLdoc 3.2

Changed 3 years ago by mgalloy

  • version changed from 3.0 to 3.2
  • milestone changed from IDLdoc 3.2 to IDLdoc 3.3

Changed 3 years ago by mgalloy

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.

Changed 3 years ago by mgalloy

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.

Changed 3 years ago by mgalloy

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

Changed 3 years ago by mgalloy

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

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.

Note: See TracTickets for help on using tickets.