Ticket #54 (assigned enhancement)

Opened 3 years ago

Last modified 3 months ago

Allow user-defined headers

Reported by: mgalloy Owned by: mgalloy
Priority: minor Milestone: IDLdoc 3.4
Component: core Version: 3.3
Keywords: Cc:

Description

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

Change History

Changed 21 months ago by 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...

Changed 16 months ago by mgalloy

  • milestone changed from IDLdoc 3.3 to IDLdoc 3.4

Changed 16 months ago by mgalloy

  • version changed from 3.2 to 3.3

Changed 3 months ago by mgalloy

  • status changed from new to assigned
Note: See TracTickets for help on using tickets.