| IDLDoc Markup [message #78314] |
Sun, 13 November 2011 08:28  |
David Fanning
Messages: 11724
Registered: August 2001
|
Senior Member |
|
|
Folks,
I have a question about IDLDoc mark-up. I'm using version
3.3 of IDLDocs, and I am using the rst mark-up style.
I would like to be able to include in the documentation
a "Notes" field in which I can place information about
an algorithm or the program that is pertinent background
information, but which doesn't exactly fit in other
categories.
Does anyone know how to do this?
Thanks,
David
--
David Fanning, Ph.D.
Fanning Software Consulting, Inc.
Coyote's Guide to IDL Programming: http://www.idlcoyote.com/
Sepore ma de ni thui. ("Perhaps thou speakest truth.")
|
|
|
|
| Re: IDLDoc Markup [message #78404 is a reply to message #78314] |
Mon, 14 November 2011 12:21  |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On 11/13/11 9:28 AM, David Fanning wrote:
> Folks,
>
> I have a question about IDLDoc mark-up. I'm using version
> 3.3 of IDLDocs, and I am using the rst mark-up style.
> I would like to be able to include in the documentation
> a "Notes" field in which I can place information about
> an algorithm or the program that is pertinent background
> information, but which doesn't exactly fit in other
> categories.
>
> Does anyone know how to do this?
There is no specific field for notes/algorithm/background. I normally
just make the first paragraph of the comments a basic description of the
routine's purpose and following paragraphs about other pertinent
details. For example:
;+
; MY_ROUTINE performs ...
;
; This routine uses the XYZ algorithm, discussed in ...
;-
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL, A Guide to Learning IDL: http://modernidl.idldev.com
Research Mathematician
Tech-X Corporation
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
