mgalloy / idldoc

Documenting IDL code
Other
20 stars 13 forks source link

Add preformatted markup style #52

Closed mgalloy closed 11 years ago

mgalloy commented 11 years ago

From Steven Martin:

I would like to run IDLdoc on some older IDL code which has the old-style IDL block comments (;+ ;-). The comment block itself doesn't necessarily have any of the accepted tags. So, I just want IDLdoc to copy the comment block as is to the output HTML. However, even when I set markup_style='verbatim', I notice that carriage returns seem to be ignored. That is, a comment block like this:

;+
; Just an example comment block.
; Purpose:
;   test
; Created by:
;   S. Martin
;-

would appear in the IDLdoc generated HTML as:

Just an example comment block. Purpose: test Created by: S. Martin

Is there a way to preserve the formatting as it appears in the original source file?

I realize that to make full use of IDLdoc I really need to adhere to the commenting standards and use the proper tags, etc... But for older code I'd still like to generate a readable comment doc.

mgalloy commented 11 years ago

Added in r629.