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 #72655 is a reply to message #72510]

Mon, 20 September 2010 21:20

David Fanning
Messages: 11724
Registered: August 2001

Senior Member

Michael Galloy writes:

> But, in the meantime, you are correct, the FORMAT_STYLE and MARKUP_STYLE
> determine how the comments are formatted in the output. Looking at some
> of the code in your library, it looks like you probably should use
> FORMAT_STYLE='IDL' and MARKUP_STYLE='preformatted' (it won't look good,
> but should be readable). The MARKUP_STYLE='preformatted' will make
> linefeeds significant.

I have finally managed to get something that looks hopeful,
but, yes, it took me quite a while to find the right page
with the information I needed. I think the new documentation
will be well received. :-)

> You will also need to make the comment header
> (i.e., the part between ;+ and ;-) be next to the routine prototype (the
> pro/function line), like:

Yes, I have a question about that. What do you do in the
case of a large file with many modules? The module I want
to document is, of course, at the bottom of the file. And
yet I want the documentation to appear at the top of the
file. How would you handle something like that?

Also, I want to have the copyright notice (as some significant
amount of text) in the file. What would be the best way to
handle that? There really isn't a category for that, and
it seems a little strange to put it someplace like after
the procedure definition statement (which would follow
immediately after the documentation) and before the first
line of code in the procedure.

The copyright thing is on my mind today, as I am in the
process of moving the Coyote and Catalyst Libraries over
to GoogleCode, so people can access it via a Subversion
repository.

Thanks for the help!

Cheers,

David

--
David Fanning, Ph.D.
Fanning Software Consulting, Inc.
Coyote's Guide to IDL Programming: http://www.dfanning.com/
Sepore ma de ni thui. ("Perhaps thou speakest truth.")

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: Sun Oct 12 11:21:55 PDT 2025

Total time taken to generate the page: 1.12182 seconds