comp.lang.idl-pvwave archive: archive

Home » Public Forums » archive » IDLDoc Bandwagon

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

Re: IDLDoc Bandwagon [message #72640 is a reply to message #72510]

Tue, 21 September 2010 14:12

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

On 9/21/10 11:17 am, David Fanning wrote:
> Michael Galloy writes:
>
>> Yes, you can put file-level comments at the beginning of the file, i.e.,
>> comments between ;+ and ;- that are not immediately next to a routine
>> header are "file-level." I generally put documentation about each
>> routine in the header right next to that routine and file-level stuff
>> about the whole file like what the "public" routines in the file are in
>> the file-level comments.
>
> OK, I'm getting to something I can live with, but I want to
> move to the "rst" format. In this format, how can I put multiple
> line examples into the documentation? For example, something
> like this:
>
> IDL> a = findgen(11)
> IDL> MinMax, a
> MinMax: 0 10
>
> Also, would it be possible to put these kind of code fragments
> in some kind of "code" type font?

Yes, in "rst" markup this would be:

; The `MinMax` routine gives the range of a variable::
;
; IDL> a = findgen(11)
; IDL> MinMax, a
; MinMax: 0 10

You need a blank line between the '::' and the code start as well as an
indent for the code. You don't need text explanation if you don't want:

; ::
;
; IDL> a = findgen(11)
; IDL> MinMax, a
; MinMax: 0 10

Mike
--
www.michaelgalloy.com
Research Mathematician
Tech-X Corporation

Report message to a moderator

[Message index]

		IDLDoc Bandwagon By: David Fanning on Mon, 20 September 2010 16:48
		Re: IDLDoc Bandwagon By: David Fanning on Tue, 21 September 2010 14:32
		Re: IDLDoc Bandwagon By: Michael Galloy on Tue, 21 September 2010 14:12
		Re: IDLDoc Bandwagon By: David Fanning on Tue, 21 September 2010 10:17
		Re: IDLDoc Bandwagon By: Michael Galloy on Tue, 21 September 2010 07:16
		Re: IDLDoc Bandwagon By: Michael Galloy on Tue, 21 September 2010 07:02
		Re: IDLDoc Bandwagon By: David Fanning on Mon, 20 September 2010 21:53
		Re: IDLDoc Bandwagon By: penteado on Mon, 20 September 2010 21:30
		Re: IDLDoc Bandwagon By: penteado on Mon, 20 September 2010 21:23
		Re: IDLDoc Bandwagon By: David Fanning on Mon, 20 September 2010 21:20
		Re: IDLDoc Bandwagon By: penteado on Mon, 20 September 2010 21:16
		Re: IDLDoc Bandwagon By: Michael Galloy on Mon, 20 September 2010 20:54
		Re: IDLDoc Bandwagon By: penteado on Mon, 20 September 2010 18:29
		Re: IDLDoc Bandwagon By: penteado on Mon, 20 September 2010 18:27

Previous Topic:	The variable shellCmd is not defined
Next Topic:	Coyote and Catalyst Libraries Available on SVN Repository

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Sat Oct 11 11:15:32 PDT 2025

Total time taken to generate the page: 1.19638 seconds