| IDLDoc Question [message #73481] |
Thu, 11 November 2010 13:19 |
David Fanning
Messages: 11724
Registered: August 2001
|
Senior Member |
|
|
Folks,
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?
Thanks,
David
--
David Fanning, Ph.D.
Fanning Software Consulting, Inc.
Coyote's Guide to IDL Programming: http://www.dfanning.com/
Sepore ma de ni thui. ("Perhaps thou speakest truth.")
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
