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 #23397 is a reply to message #23387]

Tue, 23 January 2001 07:34

James Kuyper
Messages: 425
Registered: March 2000

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?

No. That's fundamentally an impossible task. Complete documentation
includes things that don't reside in your source code and can't be
derived from it, such as a list of the requirements it must meet, a
description of how it fits into the larger picture, explanations of your
design decisions (including why you DIDN'T do certain things), a user's
guide, and the revision history.
Now, in any language that supports comments, you can insert those things
in your code, but they can't be derived from the code itself.

> 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...

Those are all useful things to do; just don't confuse them with
"complete" documentation.
Unfortunately, I'm unaware of any existing facilities for collecting
such information from IDL files, but others may know more about such
things.

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: Sat Oct 11 13:12:07 PDT 2025

Total time taken to generate the page: 1.76081 seconds