comp.lang.idl-pvwave archive: archive

Home » Public Forums » archive » IDLDOC question

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

Re: IDLDOC Question [message #74572 is a reply to message #66975]

Tue, 25 January 2011 09:27

Paul Van Delst[1]
Messages: 1157
Registered: April 2002

Senior Member

Michael Galloy wrote:
> The "guiding philosophy" of IDLdoc is to place the documentation
> for something as close as possible to the actual definition in the code
> so that the documentation actually is updated as the code is updated.

Based on my own experience (not just with IDL), I think this is a good philosophy. Debugging header documentation is
devilishly hard.... unless, I guess, you use a preprocessor to generate it directly from the code (like RDoc for ruby).

Anyway.... regarding David Fanning's original question.....

With my own widget code where I there is the usual bunch of private "helper" procedures/functions preceding the main
routine, I have taken to either putting them in their own files (for the bigger ones) or in an include file that is
included at the top of the file. I got tired of having to scroll up/down searching for the routines during editing, or
having a split-pane edit window.

David, what about doing something like

-----%<-----
@mywidgetapp_helper.pro

; main routine documentation
;
;
; .....
;
;
PRO mywidgetapp, args...., keywords.....
...just the main widget app code...
END
-----%<-----

where the "mywidgetapp_helper.pro" file contains all the associated code for the main app.

??

cheers,

paulv

p.s. I use the same approach when I generate "syntactic sugar" routines for objects - the include file is at the top of
my "XXXXX__define.pro" file.

Report message to a moderator

[Message index]

		IDLDOC question By: David Gell on Mon, 29 June 2009 07:12
		Re: IDLDoc Question By: David Fanning on Thu, 11 November 2010 14:13
		Re: IDLDoc Question By: Michael Galloy on Fri, 12 November 2010 09:28
		Re: IDLDoc Question By: Michael Galloy on Thu, 11 November 2010 13:54
		Re: IDLDOC Question By: David Fanning on Tue, 25 January 2011 10:33
		Re: IDLDOC Question By: Paul Van Delst[1] on Tue, 25 January 2011 09:27
		Re: IDLDOC Question By: Michael Galloy on Mon, 24 January 2011 15:39
		Re: IDLDOC Question By: Jeremy Bailin on Thu, 20 October 2011 11:48
		Re: IDLDOC Question By: Michael Galloy on Thu, 20 October 2011 12:42
		Re: IDLDOC question By: Michael Galloy on Wed, 07 December 2011 19:03
		Re: IDLDOC question By: David Fanning on Wed, 07 December 2011 14:32
		Re: IDLDOC question By: manodeep@gmail.com on Wed, 07 December 2011 13:56
		Re: IDLDOC question By: David Fanning on Wed, 07 December 2011 14:07
		Re: IDLDOC question By: Brian Wolven on Wed, 07 December 2011 13:32
		Re: IDLDOC question By: David Fanning on Wed, 07 December 2011 13:13

Previous Topic:	Re: Removing Array Values
Next Topic:	Interpolation

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Sun Oct 12 00:42:04 PDT 2025

Total time taken to generate the page: 0.48281 seconds