| Re: IDLDoc Error [message #78393] |
Wed, 16 November 2011 10:08  |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On 11/14/11 3:33 PM, David Fanning wrote:
> David Fanning writes:
>
>> So, this afternoon I turned my attention to updating
>> my ActiveContour software. I marked up all the files
>> with rst mark-up, and when I was finished I executed
>> the very same idldoc command I have been using all
>> week:
>>
>> IDL> idldoc, $
>> root='c:\idl\activecontour\source', $
>> output='c:\idl\activecontour\source\activecontourdocs', $
>> title='Coyote Graphics Active Contour Routines', $
>> subtitle= 'Date: ' + Systime(), /NoSource
>>
>> Only this time, I get the following error:
>>
>> Copying resources...
>> Parsing .\...
>> Parsing testapplication.pro...
>> % IDLDOC: Array dimensions must be greater than 0.
>>
>> If I remove testapplication.pro, it fails on the next
>> file. In fact, it won't work with *any* file in the
>> directory. Which leads me to conclude something
>> else is wrong. Does anyone have any clues?
>
> With Mike's help, we have traced this down to
> a problem with the :Requires: tag. He was making
> some assumptions about what would go into this tag
> which wasn't true in my case. The problem is fixed
> and will appear in the next release of IDLDocs, which
> should occur within the next few weeks.
>
> Thanks for the help, Mike!
If you would like to try the new release, I have a 3.4 beta release
available:
http://michaelgalloy.com/wp-content/uploads/2011/11/idldoc-3 .4beta.zip
And here is the full source code version:
http://michaelgalloy.com/wp-content/uploads/2011/11/idldoc-3 .4beta-src.zip
This is mostly a bug fix version, but there is on big feature: LaTeX
equation formatting. To use LaTeX equations in your docs, just use
standard LaTeX syntax anywhere plain text is allowed. For example, here
is an example of using an equation in the main description:
;+
; Inverse hyperbolic cosine. Uses the formula:
;
; $$\text{acosh}(z) = \ln(z + \sqrt{z + 1} \sqrt{z - 1})$$
;
; :Returns:
; float, double, complex, or double complex depending on the input
;
; :Params:
; z : in, required, type=numeric
; input
;-
Inline equations are also allowed. Both can appear in the main
description and inside most tags (anywhere comments are just copied over
to the output).
Please let me know if you find any issues. I would like to release 3.4
next week.
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
