search

mgalloy / idldoc

Documenting IDL code
Other
21 stars 13 forks source link

Suggest allowing @file_comments at file level #21

Closed mgalloy closed 11 years ago

mgalloy commented 11 years ago

IDLDoc2.0 implied that @file_comments could be used at the start of a file and not just in routine comments. (Help indicated it to be "file level" comments)

In IDLDoc3.0 it seems implied that the initial (non-tagged) text at the file level should be treated as file comments. I suggest that if the tag @file_comments is present that it should also treat the following text as file comments. This would avoid potentially needless correction of previous documentation.

mgalloy commented 11 years ago

Yes, that would help compatibility issues. Added in r431.