comp.lang.idl-pvwave archive: archive » Can't seem to "Add routine comments"

Home » Public Forums » archive » Can't seem to "Add routine comments" - IDLdoc?

Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend

Can't seem to "Add routine comments" - IDLdoc? [message #88921]

Thu, 03 July 2014 11:25

BLesht
Messages: 89
Registered: March 2007

Member

Thinking I'd try to be better about documenting new code I tried the "Add Routine Comments" from the "Source" menu to a new file but nothing happens. However, when I try to "Add File Comments," I get the expected insert the file I'm editing. I've looked at Preferences/IDL/IDLdoc and the templates for both the routine and file comments are there. Any idea why I can get one and not the other? The IDLdoc repository with its sub-directories is in my path. I'm running IDL8.2.3 on MacOS10.8.5 and using the IDLDE.

Thanks.

Report message to a moderator

Re: Can't seem to "Add routine comments" - IDLdoc? [message #88923 is a reply to message #88921]

Thu, 03 July 2014 14:10

Fabzi
Messages: 305
Registered: July 2010

Senior Member

Hi,

for "Add routine comments" your cursor needs to be on a routine name,
maybe compiled I don't know. It's very practical since it reads all your
parameters/keywords

IDLdoc has not much to do with it, except that IDL/Eclipse adopted the
rst format that Mike promotes

On 03.07.2014 20:25, Barry Lesht wrote:
> Add Routine Comments

Report message to a moderator

Re: Can't seem to "Add routine comments" - IDLdoc? [message #88924 is a reply to message #88921]

Thu, 03 July 2014 14:49

Phillip Bitzer
Messages: 223
Registered: June 2006

Senior Member

Here's my template (Preferences->IDL->IDLDoc:

;+
; Description...What does this do?
;
; :Returns:
; Does it return a value?
;
; ${parameters} : in, required, type=type
;
; ${keywords} : in, optional, type=type, default=default
;
; :Uses:
; OtherRoutines
;
;-

compile_opt idl2

When I right click-> Add Routine Comments _anywhere_ in the routine, my template gets added below the declaration (my preference). Works for subroutines, too.

Sometimes, I get funky things that happen in the Workbench (e.g., code folding not working). A restart of the Workbench seems to solve the problem.

I just tried this on a old routine that did not have doc, but was compiled. Worked fine. I'm also on 8.2.3, Mac 10.9.3.

Not sure if this helps, or just rubs salt in the wound :-)

Report message to a moderator

Re: Can't seem to "Add routine comments" - IDLdoc? [message #88926 is a reply to message #88921]

Thu, 03 July 2014 15:11

BLesht
Messages: 89
Registered: March 2007

Member

Ah! Thanks to you both. I completely misunderstood its use. I was just trying to get the doc header into a new file that I was starting to edit. Barry

Report message to a moderator

Previous Topic:	Gaussfit problem
Next Topic:	How can IDL interact with a web service client?

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Wed Oct 08 15:39:53 PDT 2025

Total time taken to generate the page: 0.00428 seconds