comp.lang.idl-pvwave archive: archive » Re: creating documentation file

Home » Public Forums » archive » Re: creating documentation file

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

Re: creating documentation file [message #43105 is a reply to message #43104]

Wed, 16 March 2005 04:28

David Fanning
Messages: 11724
Registered: August 2001

Senior Member

urkhaa@hotmail.com writes:

> Here am I again....
> I have to admit that I really do not understand how to use correctly
> IDLdoc. Actually it seems to me that if I would like to create a single
> HTML file for all my library (which links to single file description) I
> have to previously create an overview file which in some way link to
> all the routines (actually I have a directory for my library and other
> subdirectories inside it) ... but I really do not understand how to
> make it. Maybe this is a stupid question and I apologize for it if it
> is the case but can anyone help me?

Here is the routine I've used for years to document my
Coyote Library. It's simple, efficient, and results in
a single HTML page. It lacks a couple of features I
would like to have (and DocLib contains), but I agree:
I'm not sure DocLib is so much better it is worth
reworking ALL my documentation!

;*********************************************************** ******
PRO HTML_Doc

CD, Current=thisDir
CD, 'C:\coyoteguide\programs'
files = Findfile('*.pro')

MK_HTML_Help, files, 'program.documentation.html', Title='IDL Example
Programs'

; Make the IDLWAVE Catalog file.

SPAWN, 'perl C:/CoyoteGuide/Miscellaneous/idlwave_catalog $
-f Coyote', /NoShell
CD, thisDir
END
;*********************************************************** ******

Cheers,

David
--
David Fanning, Ph.D.
Fanning Software Consulting, Inc.
Coyote's Guide to IDL Programming: http://www.dfanning.com/

Report message to a moderator

[Message index]

		Re: creating documentation file By: Antonio Santiago on Wed, 16 March 2005 04:38
		Re: creating documentation file By: David Fanning on Wed, 16 March 2005 04:28
		Re: creating documentation file By: urkhaa on Wed, 16 March 2005 01:13
		Re: creating documentation file By: urkhaa on Tue, 15 March 2005 08:55
		Re: creating documentation file By: David Fanning on Tue, 15 March 2005 08:28
		Re: creating documentation file By: Antonio Santiago on Tue, 15 March 2005 08:18
		Re: creating documentation file By: Antonio Santiago on Tue, 15 March 2005 08:14
		Re: creating documentation file By: David Fanning on Tue, 15 March 2005 07:49
		Re: creating documentation file By: Jim Pendleton, RSI on Tue, 15 March 2005 07:18
		Re: creating documentation file By: Benjamin Hornberger on Tue, 15 March 2005 06:45

Previous Topic:	robust outlier detection (spikes in data)
Next Topic:	Re: objets solarsoft

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Sat Oct 11 23:21:17 PDT 2025

Total time taken to generate the page: 0.80098 seconds