comp.lang.idl-pvwave archive: archive » Re: IDL Documentation tool?

Home » Public Forums » archive » Re: IDL Documentation tool?

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

Re: IDL Documentation tool? [message #23387]

Wed, 24 January 2001 00:45

plugge
Messages: 17
Registered: May 1995

Junior Member

In article <3A6CCA1B.496CB694@ssrl.slac.stanford.edu>, Daniel Luebbert
<luebbert@ssrl.slac.stanford.edu> writes:
|>Hi there,
|>
|>I am trying to generate a documentation for a large bunch of IDL
|>programs of mine,
|>so that someone else could easily understand and use them.
|>Does anyone know of a program, PERL script, commercial tool or whatever
|>else
|>which could generate a complete documentation from the source code?
|>
|>It should certainly include a list of routines in each file, with the
|>respective arguments and keywords,
|>and also extra any header documentation like "doc_library" does.
|>But ideally it should also analyze which other routines each file uses,
|>maybe detect common block incompatibilities,
|>etc., etc...
|>
|>I know for instance that Java comes with a neat little program
|>"javadoc", which does much of the above.
|>If anybody is aware of something similar for IDL, I would be most
|>grateful for a hint.
|>
|>Daniel

Daniel,
some time ago I wrote a prettyprinter for IDL that could be a (first!!)
approach for your problem. It converts an IDL source file to LaTeX, optionally
generating an index of routines and common blocks and a table of contents.
I use it frequently to generate listings of the exercises done by the students
here (it is used also as a kind of printer filter for IDL).

If you are interested, I could send you an example .dvi or .ps file for an
first impression. The converter is freeware (GNU GPL) and comes with full
source; so you can modify it for your needs.

Best regards

Michael Plugge

Report message to a moderator

[Message index]

		Re: IDL Documentation tool? By: plugge on Wed, 24 January 2001 00:45
		Re: IDL Documentation tool? By: James Kuyper on Tue, 23 January 2001 07:34
		Re: IDL Documentation tool? By: R.Bauer on Mon, 22 January 2001 23:58
		Re: IDL Documentation tool? By: davidf on Mon, 22 January 2001 18:25
		Re: IDL Documentation tool? By: Paul van Delst on Mon, 22 January 2001 17:09
		Re: IDL Documentation tool? By: Jason P. Meyers on Mon, 22 January 2001 17:11
		Re: IDL Documentation tool? By: Craig Markwardt on Mon, 22 January 2001 16:42

Previous Topic:	Socket!
Next Topic:	Re: How to redirect stdout & stderr from a Windows app?

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Wed Oct 08 15:33:39 PDT 2025

Total time taken to generate the page: 0.00461 seconds