comp.lang.idl-pvwave archive: archive

Home » Public Forums » archive » IDLDOC question

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

Re: IDLDoc Question [message #73476 is a reply to message #66975]

Thu, 11 November 2010 13:54

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

On 11/11/10 2:19 PM, David Fanning wrote:
> I've been making an effort to use Mike Galloy's IDLDoc
> program for all my program documentation in new programs
> I am writing. It is going reasonably well, but I keep
> running into things I just can't quite figure out how
> to do. I can use some help. I am using the 'rst' markup
> style.
>
> I am writing a wrapper for another routine. I am adding
> a few of my own keywords, but most of the keywords I
> expect will be keywords for the routine I am wrapping.
> I can gather these up and pass them along with _EXTRA,
> of course. But a few of the "extra" keywords I care about
> because my wrapper handles them in slightly different
> ways and because I want my wrapper to define some of
> these keywords in case they *are not* used.
>
> I don't necessarily want to "define" these keywords.
> The user knows what they mean and how they are used.
> There is no point in documenting them.
>
> But I need to define them on the wrapper procedure
> definition line, or I can't fish them out of the
> "extra" structure and use them the way I want to use
> them. Naturally, since they are defined there, these
> "keywords" show up in my final documentation. Is there
> a way to "hide" keywords I don't want to document?

You you can make a keyword "private", i.e.

; :Keywords:
; my_secret_keyword : in, optional, private, type=boolean
; I don't want this description to show up in the documentation

You can also make a keyword "hidden" in the same way: private items will
show up in "developer" documentation (i.e., when you run IDLdoc without
the /USER keyword set) and hidden items *never* show up.

The private/hidden status can also be set on routines, files, and
directories.

Mike
--
www.michaelgalloy.com
Research Mathematician
Tech-X Corporation

Report message to a moderator

[Message index]

		IDLDOC question By: David Gell on Mon, 29 June 2009 07:12
		Re: IDLDoc Question By: David Fanning on Thu, 11 November 2010 14:13
		Re: IDLDoc Question By: Michael Galloy on Fri, 12 November 2010 09:28
		Re: IDLDoc Question By: Michael Galloy on Thu, 11 November 2010 13:54
		Re: IDLDOC Question By: David Fanning on Tue, 25 January 2011 10:33
		Re: IDLDOC Question By: Paul Van Delst[1] on Tue, 25 January 2011 09:27
		Re: IDLDOC Question By: Michael Galloy on Mon, 24 January 2011 15:39
		Re: IDLDOC Question By: Jeremy Bailin on Thu, 20 October 2011 11:48
		Re: IDLDOC Question By: Michael Galloy on Thu, 20 October 2011 12:42
		Re: IDLDOC question By: Michael Galloy on Wed, 07 December 2011 19:03
		Re: IDLDOC question By: David Fanning on Wed, 07 December 2011 14:32
		Re: IDLDOC question By: manodeep@gmail.com on Wed, 07 December 2011 13:56
		Re: IDLDOC question By: David Fanning on Wed, 07 December 2011 14:07
		Re: IDLDOC question By: Brian Wolven on Wed, 07 December 2011 13:32
		Re: IDLDOC question By: David Fanning on Wed, 07 December 2011 13:13

Previous Topic:	Re: Removing Array Values
Next Topic:	Interpolation

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Sat Oct 11 04:22:43 PDT 2025

Total time taken to generate the page: 0.80181 seconds