| Re: IDLDOC 3.2 Index page not as interesting as it could be... [message #66956] |
Mon, 15 June 2009 16:04  |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
Gianguido Cianci wrote:
> Not sure how many of you use IDLDOC to document your code. I like it a
> lot.
>
> I have noticed that when I run it, if I got to the 'Overview' I see a
> list of directories where my code is stored. If I click on one of
> those directories I see a list of procedures, with the 1st sentence of
> the description underneath each one.
>
> Something like:
>
> <a>arraypad.pro</a>
>
> Pads arrays on each side with zeros or a user supplied
> value.
>
>
> However, when I go to the "Index" section, I get mu less interesting
> info:
>
> <a>arraypad</a>
> routine in arraypad.pro
> <a>arraypad.pro</a>
> .pro file in ./ directory
>
> Is there a way to get the "Index" section to also display the 1st
> sentence of the documentation?
> Wouldn't it be more interesting to have this first sentence appear
> under the procedures in the "categories" page? Am I missing
> something?
No, there isn't a way to do this currently, but this is a good idea.
I've created a feature request for this in IDLdoc 3.3:
http://idldoc.idldev.com/ticket/53
Mike
--
www.michaelgalloy.com
Associate Research Scientist
Tech-X Corporation
|
|
|
|
| Re: IDLDOC 3.2 Index page not as interesting as it could be... [message #67291 is a reply to message #66956] |
Mon, 13 July 2009 12:05  |
Michael Galloy
Messages: 1114
Registered: April 2006
|
Senior Member |
|
|
mgalloy wrote:
> Gianguido Cianci wrote:
>> Not sure how many of you use IDLDOC to document your code. I like it a
>> lot.
>>
>> I have noticed that when I run it, if I got to the 'Overview' I see a
>> list of directories where my code is stored. If I click on one of
>> those directories I see a list of procedures, with the 1st sentence of
>> the description underneath each one.
>>
>> Something like:
>>
>> <a>arraypad.pro</a>
>>
>> Pads arrays on each side with zeros or a user supplied
>> value.
>>
>>
>> However, when I go to the "Index" section, I get mu less interesting
>> info:
>>
>> <a>arraypad</a>
>> routine in arraypad.pro
>> <a>arraypad.pro</a>
>> .pro file in ./ directory
>>
>> Is there a way to get the "Index" section to also display the 1st
>> sentence of the documentation?
>> Wouldn't it be more interesting to have this first sentence appear
>> under the procedures in the "categories" page? Am I missing
>> something?
>
> No, there isn't a way to do this currently, but this is a good idea.
> I've created a feature request for this in IDLdoc 3.3:
>
> http://idldoc.idldev.com/ticket/53
This feature is now in the trunk. You can check it out with Subversion:
svn co http://svn.idldev.com/idldoc/trunk/idldoc
Mike
--
www.michaelgalloy.com
Associate Research Scientist
Tech-X Corporation
|
|
|
|
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
