Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow user-defined headers #44

Open
mgalloy opened this issue Oct 22, 2012 · 1 comment
Open

Allow user-defined headers #44

mgalloy opened this issue Oct 22, 2012 · 1 comment
Assignees
Milestone

Comments

@mgalloy
Copy link
Owner

mgalloy commented Oct 22, 2012

IDLdoc should allow unrecognized headers as standard file/routine attributes and pass them through into the documentation. This request was originally from #51.

@ghost ghost assigned mgalloy Oct 22, 2012
@mgalloy
Copy link
Owner Author

mgalloy commented Oct 22, 2012

Author: APanasenco
I think this is ''already'' implemented, no?

Something like this:

;+
; ===This is a non-standard header.===
; Some ASCII art goes here.
;            (too lazy to google for some)
;-

;+
;This is a non-standard function/procedure attribute header thing
;It can have some descriptions
;Two men walk into a bar
;  SOMEFUNCTION
; Parameters:
;            SOMEPARAMETERS
;                     INCREDIBLY LONG MODIFICATION LIST
;      *****************
; ----------
; ()()()
;-
function SOMEFUNCTION, SOMEPARAMETER
    return, SOMEVALUE
end

...works as well as it can. The file header is placed under the file name, and the function header is placed under the syntax.

Unless, of course, the ticket is talking about line concatenation that occurs...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant