| IDLdoc 3.0 released [message #58156] |
Mon, 21 January 2008 21:47  |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
IDLdoc 3.0 is ready! Highlights of this release:
* IDLdoc 3.0 was rewritten from scratch to allow it to be released
under an open source license. Source code is available from the
project website.
* There are multiple formats for entering comments: the normal
IDLdoc style, the traditional IDL comment header, and new style based
on restructured text.
* Ability to do some simple formatting of comments without resorted
to putting ugly HTML into your comments.
For more information about this release, see the project website
download page:
http://idldoc.idldev.com/wiki/Downloads
Mike
--
www.michaelgalloy.com
Tech-X Corporation
Software Developer II
|
|
|
|
| Re: IDLdoc 3.0 released [message #58233 is a reply to message #58156] |
Wed, 23 January 2008 11:27  |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On Jan 23, 9:01 am, David Fanning <n...@dfanning.com> wrote:
> mgal...@gmail.com writes:
>> Use:
>
>> IDL> idldoc, root=3Droot, output=3Doutput, format_style=3D'IDL'
>
>> The default FORMAT_STYLE is 'IDLdoc' to keep backward compatibility
>> with older versions.
>
> OK, better. But a great deal of the information seems to be
> missing. Especially the descriptions of the keywords and
> parameters. Do you suppose this is because of my overuse
> of white space? Could I write my own template to parse the
> kind of document headers I write?
The problem is the license and blank lines between the ";-" and the
"function aspect" line. Currently, IDLdoc associates the comment block
with the file, not the routine. So some of the blocks in it are
ignored. It is a current feature request to associate a file level
comment header in the IDL style with the last routine in the file.
The current workaround is to make sure that ;- and "function
aspect..." are adjacent, i.e. move the license to the beginning of the
file.
Mike
--
www.michaelgalloy.com
Tech-X Corporation
Software Developer II
|
|
|
|
| Re: IDLdoc 3.0 released [message #58236 is a reply to message #58156] |
Wed, 23 January 2008 10:50 |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
On Jan 23, 9:01 am, David Fanning <n...@dfanning.com> wrote:
> mgal...@gmail.com writes:
>> Use:
>
>> IDL> idldoc, root=3Droot, output=3Doutput, format_style=3D'IDL'
>
>> The default FORMAT_STYLE is 'IDLdoc' to keep backward compatibility
>> with older versions.
>
> OK, better. But a great deal of the information seems to be
> missing. Especially the descriptions of the keywords and
> parameters. Do you suppose this is because of my overuse
> of white space? Could I write my own template to parse the
> kind of document headers I write?
Let me try to doc the file your linked to and see what the problem is.
The main problem with the "IDL" style is that it is a bit "free
form".
It is possible to write your own format style parser, but that's not
for the faint of heart. I think having a more rigorous IDL format
parser would be a better solution right now.
> P.S. Mike, I feel your pain in having to devote full time
> to User Support, but it's greatly appreciated. :-)
No problem. Comments here have already helped me create more
documentation.
Mike
--
www.michaelgalloy.com
Tech-X Corporation
Software Developer II
|
|
|
|
| Re: IDLdoc 3.0 released [message #58239 is a reply to message #58156] |
Wed, 23 January 2008 08:01 |
David Fanning
Messages: 11724
Registered: August 2001
|
Senior Member |
|
|
mgalloy@gmail.com writes:
> Use:
>
> IDL> idldoc, root=3Droot, output=3Doutput, format_style=3D'IDL'
>
> The default FORMAT_STYLE is 'IDLdoc' to keep backward compatibility
> with older versions.
OK, better. But a great deal of the information seems to be
missing. Especially the descriptions of the keywords and
parameters. Do you suppose this is because of my overuse
of white space? Could I write my own template to parse the
kind of document headers I write?
Cheers,
David
P.S. Mike, I feel your pain in having to devote full time
to User Support, but it's greatly appreciated. :-)
--
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.")
|
|
|
|
|
|
| Re: IDLdoc 3.0 released [message #58245 is a reply to message #58156] |
Wed, 23 January 2008 07:28 |
David Fanning
Messages: 11724
Registered: August 2001
|
Senior Member |
|
|
Brian Larsen writes:
> I decided to go through my library last night and see what could
> be done "out of the box" and it worked great.
I tried this "out of the box" thing, too. But my results
were not so great. :-(
I tried documenting this file, which uses a fairly
routine IDL doc template:
http://www.dfanning.com/programs/aspect.pro
And the result looked like this:
NAME: ASPECT PURPOSE: This function calculates and returns the
normalized position coordinates necessary to put a plot with a specified
aspect ratio into the currently active graphics window. It works on the
display output window as well as in a PostScript output window.CATEGORY:
Graphics CALLING SEQUENCE: position = ASPECT(aspectRatio) INPUTS:
aspectRatio: A floating point value that is the desired aspect ratio
(ratio of heigth to width) of the plot in the current graphics output
window. If this parameter is missing, an aspect ratio of 1.0 (a square
plot) is assumed. KEYWORDS: MARGIN: The margin around the edges of the
plot. The value must be a floating point value between 0.0 and 0.5. It
is expressed in normalized coordinate units. The default margin is 0.15.
WINDOWASPECT: The aspect ratio of the target window. If not provided,
the value is obtained from the current graphics window. OUTPUTS:
position: A four-element floating array of normalized coordinates. The
order of the elements is [x0, y0, x1, y1], similar to the !P.POSITION
system variable or the POSITION keyword on any IDL graphic command.
EXAMPLE: To create a plot with an aspect ratio of 1:2 and a margin of
0.10 around the edge of the output window, do this: plotPosition =
ASPECT(0.5, Margin=0.10) PLOT, Findgen(11), POSITION=plotPosition Notice
this can be done in a single IDL command, like this: PLOT, Findgen(11),
POSITION=ASPECT(0.5, Margin=0.10) MODIFICATION HISTORY: Written by:
David Fanning, November 1996. Added better error checking, 18 Feb 1997,
DWF. Added WindowAspect keyword. 10 Feb 2000. DWF Added double precision
tolerance for aspectRatio. 9 NOV 2001 BT
Not really what I had in mind. :-(
What would I have to do to fix this?
Cheers,
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.")
|
|
|
|
|
|
| Re: IDLdoc 3.0 released [message #58262 is a reply to message #58156] |
Wed, 23 January 2008 02:50 |
Foldy Lajos
Messages: 268
Registered: October 2001
|
Senior Member |
|
|
On Wed, 23 Jan 2008, Ingo von Borstel wrote:
> Hi,
>
>> * IDLdoc 3.0 was rewritten from scratch to allow it to be released
>> under an open source license. Source code is available from the
>> project website.
>
> Sounds pretty cool. Unfortunately when trying to run it I run into a
> problem:
>
> IDL> restore, 'idldoc.sav'
> IDL> idldoc, root='/idltools/pfctools2', output='/idltools/doc',
> format='idl'
> % IDLDOC: Attempt to call undefined procedure/function: 'SCOPE_TRACEBACK'.
> IDL> print, !version
> { x86 linux unix linux 6.1 Jul 14 2004 32 64}
>
> Is my not-so new version the problem? Or where do I have to look for
> 'scope_traceback'?
>
> Best regards,
> Ingo
>
> --
> Ingo von Borstel <newsgroups@planetmaker.de>
> Public Key: http://www.planetmaker.de/ingo.asc
>
> If you need an urgent reply, replace newsgroups by vgap.
>
SCOPE_TRACEBACK was introduced in IDL 6.2.
regards,
lajos
|
|
|
|
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
