comp.lang.idl-pvwave archive: archive » Re: Using IDLdoc to format documentation

Home » Public Forums » archive » Re: Using IDLdoc to format documentation

Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend

Re: Using IDLdoc to format documentation [message #82823 is a reply to message #82820]

Tue, 15 January 2013 15:20

Phillip Bitzer
Messages: 223
Registered: June 2006

Senior Member

Perhaps Mike (or someone else) can offer a different/better solution, but I usually do something like this:

; :Returns:
; One of three possible values are returned::
; -1 IF xUTC1 < xUTC2
; 0 IF xUTC1 == XUTC2
; 1 IF xUTC1 > XUTC2

Similarly,

; :History:
; Modification 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

On Tuesday, January 15, 2013 3:09:57 PM UTC-6, David Gell wrote:
> 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.

Report message to a moderator

[Message index]

		Re: Using IDLdoc to format documentation By: Matthew Argall on Fri, 18 January 2013 15:36
		Re: Using IDLdoc to format documentation By: Mats Löfdahl on Thu, 17 January 2013 01:30
		Re: Using IDLdoc to format documentation By: David Gell on Wed, 16 January 2013 11:12
		Re: Using IDLdoc to format documentation By: Michael Galloy on Tue, 15 January 2013 15:52
		Re: Using IDLdoc to format documentation By: Phillip Bitzer on Tue, 15 January 2013 15:20
		Re: Using IDLdoc to format documentation By: Ajean on Tue, 22 January 2013 12:57
		Re: Using IDLdoc to format documentation By: Michael Galloy on Sun, 20 January 2013 10:21

Previous Topic:	Re: AstroPlotLib
Next Topic:	Re: Limit to input when creating a SAVE file?

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Fri Oct 10 06:05:18 PDT 2025

Total time taken to generate the page: 1.12506 seconds