| Another IDL Doc Question [message #78861] |
Thu, 05 January 2012 12:45  |
David Fanning
Messages: 11724
Registered: August 2001
|
Senior Member |
|
|
Folks,
I spent the better part of a couple of hours yesterday documenting
keywords in one of my programs. There are several program modules
in this file. I have defined a module description and keyword
parameters for all of them. When I run them through IDLDOC,
three of the four modules look great. But the last module in
the file refuses to document the keywords in the HTML file!
I have had this problem before if I don't get the indenting
just right. But I have been ALL OVER this file and I am
convinced the indenting in the last module is IDENTICAL
to the indenting in the first three modules. I have also
confirmed that I spelled ":Keywords": correctly.
Can anyone think of another reason I might not be seeing
these keywords documented in the output documentation?
Cheers,
David
--
David Fanning, Ph.D.
Fanning Software Consulting, Inc.
Coyote's Guide to IDL Programming: http://www.idlcoyote.com/
Sepore ma de ni thui. ("Perhaps thou speakest truth.")
|
|
|
|
| Re: Another IDL Doc Question [message #78937 is a reply to message #78861] |
Sat, 07 January 2012 14:07  |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On 1/5/12 4:31 PM, David Fanning wrote:
> David Fanning writes:
>
>> Here is another clue. At the top of the documentation that
>> *is* produced, there is a notation on this file that is
>> not present in other files. It says: "Contains a main-level
>> program."
>>
>> This is not true. The program does NOT contain a main-level
>> program. I suppose all might be right if I could figure out
>> why it thinks it does. :-(
>
> OK, problem solved!
>
> There is a module in this file that I didn't write. If has inside
> the module a WHILE loop written like this:
>
> WHILE t lt 5 DO BEGIN t = t * 10& ipow = ipow +1& ENDWHILE
>
> When I write the WHILE loop like this, all documentation
> works as expected!
>
> WHILE t lt 5 DO BEGIN
> t = t * 10& ipow = ipow +1
> ENDWHILE
>
> Who woulda known!?
>
> Cheers,
>
> David
IDLdoc does count matching begin-ends and the &'s must have thrown it
off. I will look into it.
Mike
--
Michael Galloy
www.michaelgalloy.com
Modern IDL, A Guide to Learning IDL: http://modernidl.idldev.com
Research Mathematician
Tech-X Corporation
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
