Home »
Public Forums »
archive »
Using IDLdoc to format documentation
| Using IDLdoc to format documentation [message #82828] |
Tue, 15 January 2013 13:09  |
David Gell
Messages: 29
Registered: January 2009
|
Junior Member |
|
|
I've got a couple of questions about using idldoc to format file documentation. First, I've a function that can return a status code. The header is formatted as follows:
; :RETURNS:
; -1 IF xUTC1 < xUTC2
; 0 IF xUTC1 == XUTC2
; 1 IF xUTC1 > XUTC2
The idldoc output concatenates the 3 lines:
Return Value
-1 IF xUTC1 < xUTC2 0 IF xUTC1 == XUTC2 1 IF xUTC1 > XUTC2
Is there a way to insure that the line breaks are maintained. I've found a kludge where I change the returns tag line as follows:
:Returns: ::
Note the two colons following the returns tag. This results in idldoc ouput with excessive
blank lines.
Return value
:
-1 IF xUTC1 < xUTC2
0 IF xUTC1 == XUTC2
1 IF xUTC1 > XUTC2
Is there a better way to do this. I've a similar problem with history items. if I omit the :: in the following snipet, the change history lines are all concatenated and hard to read.
; :HISTORY:
; ::
; 21 Mar 2007 D. A. Gell Initial coding
; 16 Apr 2007 D. A. Gell correct variable usage
; 7 Aug 2007 D. A. Gell added Kepler (dust) ram direction
; 3 Oct 2007 D. A. Gell corrected error in dust ram calculation. Matrix dimension
; miss-match
; 24-Mar-2009 DAG Implement global debug switch
;
This too generates a lot of extra white space in the idldoc output including a line with a stand allow colon.
|
|
|
|
Current Time: Wed Oct 08 18:03:38 PDT 2025
Total time taken to generate the page: 0.00462 seconds
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
