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 #23407 is a reply to message #23406]

Mon, 22 January 2001 17:09

Paul van Delst
Messages: 364
Registered: March 1997

Senior Member

Daniel Luebbert wrote:
>
> 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?

Uhhh... don't you write the documentation *before* the code?

At first I thought MK_HTML_HELP would do the job, but you want something to actually go in and parse
the source code and hunt about for all the dependencies along with argument lists?

Jeez.

You'd still have to modify all the routine documentation so that other users know, say, what units
the various arguments are supposed to be in. Wot a job.

It sounds like a good project in which to learn Perl.... :o) Hmmm....

Good luck.

paulv
--
Paul van Delst A little learning is a dangerous thing;
CIMSS @ NOAA/NCEP Drink deep, or taste not the Pierian spring;
Ph: (301) 763-8000 x7274 There shallow draughts intoxicate the brain,
Fax: (301) 763-8545 And drinking largely sobers us again.
Email: pvandelst@ncep.noaa.gov Alexander Pope.

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 19:30:52 PDT 2025

Total time taken to generate the page: 0.00447 seconds