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 #82820 is a reply to message #82793]

Tue, 15 January 2013 15:52

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

On 1/15/13 4:20 PM, Phillip Bitzer wrote:
> 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

Yes, I do things like that too, but find it awkward. I don't have a good
solution to this right now.

I would like to add itemized and enumerated lists to IDLdoc rst markup
with syntax something like:

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

and

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

These would make simple bullet item lists (note that this would not
align the comparison operators in the first example).

Enumerated lists would look like:

; :Returns:
; One of three possible values are returned:
;
; 1. -1 if xUTC1 < xUTC2
; 2. 0 if xUTC1 == xUTC2
; 3. 1 if xUTC1 > xUTC2

or

; :Returns:
; One of three possible values are returned:
;
; #. -1 if xUTC1 < xUTC2
; #. 0 if xUTC1 == xUTC2
; #. 1 if xUTC1 > xUTC2

Any thoughts?

Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL: A Guide to IDL Programming (http://modernidl.idldev.com)
Research Mathematician
Tech-X Corporation

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: Thu Oct 09 21:25:01 PDT 2025

Total time taken to generate the page: 0.64321 seconds