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 #43104]

Wed, 16 March 2005 04:38

Antonio Santiago
Messages: 201
Registered: February 2004

Senior Member

This is an example to show how I work with IDLdoc.
Supose my project directory is:

MyProject
|-- main.pro
|
|---Subdir1
| |--File1.pro
| \--File2.pro
|
|---Subdir2
| |--FileA.pro
| \--FileB.pro
|
\--Doc
|--API_doc(subdir)
\--idldoc (subdir)

I want to create thye API documentation for all *.pro files of my
project and put it into API_doc subdirectory.

I have put all IDLdoc files into 'idldoc' subdirectory (idldoc.sav,
idldoc.css, etc). Then I have created a file called "gendoc" (Generate
documentation :) ) like this:

PRO gendoc
idldoc, root='../../', $
output='../api', $
title='GenRad 2.0', $
subtitle='GRAHI';, $
;footer='./foot.html'
END

The root directory of my project is "two levels up" (root=../../).
I want to put the HTML generated files into API_doc subdirectory (in
this case: output=../API_doc).
Also I want my own title and subtitle :)

The only problem I have found is with "footer" keyword. I don't know if
I have created a bad foot.html but if I include this option the
resulting overview.html file is not correct :(

Well, to generate the documentation just go into de MyProject/Doc/idldoc
directory and execute "gendoc".

Bye,
Antonio.

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 Nov 29 09:51:11 PST 2025

Total time taken to generate the page: 0.47598 seconds