comp.lang.idl-pvwave archive: archive » Re: IDLdoc 3.0 released

Home » Public Forums » archive » Re: IDLdoc 3.0 released

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

Re: IDLdoc 3.0 released [message #58143 is a reply to message #58141]

Tue, 22 January 2008 09:21

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

On Jan 22, 10:05 am, Brian Larsen <balar...@gmail.com> wrote:
> I think I too must be dense... I figured out how to run it but I
> can't seem to find any documentation on how to document my code so
> that idldoc will parse it correctly. If such a thing exists can you
> point us to it? This certainly is cool and I would like to use it.

If you have run IDLdoc, then look at the index.html file in the
output. On any page of the output, there is a "Help" link at the right
in the navigation bar at the top of the page. This gives help on other
keywords to IDLdoc and to the various comment format styles available.

> For background I use the "idlwave->templates->doc" header in emacs.
> Idl doc works but everything is in the comment field below the routine
> name leaving the Parameters, and keywords with only the names with no
> descriptions.

Yes, using the default idlwave->templates->doc is the "IDL" style: use
FORMAT_STYLE='IDL' on the call to IDLdoc.

I'm working on more new user documentation, but I don't have "Getting
Started" type documentation yet.

Mike
--
www.michaelgalloy.com
Tech-X Corporation
Software Developer II

Report message to a moderator

[Message index]

		Re: IDLdoc 3.0 released By: Brian Larsen on Tue, 22 January 2008 09:59
		Re: IDLdoc 3.0 released By: KRDean on Tue, 22 January 2008 09:56
		Re: IDLdoc 3.0 released By: Brian Larsen on Tue, 22 January 2008 09:52
		Re: IDLdoc 3.0 released By: Brian Larsen on Tue, 22 January 2008 09:44
		Re: IDLdoc 3.0 released By: KRDean on Tue, 22 January 2008 09:32
		Re: IDLdoc 3.0 released By: Michael Galloy on Tue, 22 January 2008 09:21
		Re: IDLdoc 3.0 released By: Brian Larsen on Tue, 22 January 2008 09:05
		Re: IDLdoc 3.0 released By: Michael Galloy on Tue, 22 January 2008 08:01
		Re: IDLdoc 3.0 released By: Vince Hradil on Tue, 22 January 2008 05:48
		Re: IDLdoc 3.0 released By: Brian Larsen on Wed, 23 January 2008 07:09

Previous Topic:	Re: bizzare idlwave abbrev behavior
Next Topic:	Re: stop behavior

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Sat Oct 11 14:43:10 PDT 2025

Total time taken to generate the page: 0.47578 seconds