comp.lang.idl-pvwave archive: archive » [Object IDL] self-documenting objects ...

Home » Public Forums » archive » [Object IDL] self-documenting objects ...

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

[Object IDL] self-documenting objects ... [message #12389]

Fri, 31 July 1998 00:00

dEdmundson
Messages: 23
Registered: February 1998

Junior Member

I have created a number of potentially useful objects that I wish
to share with others. Of course I have documented the code and
written a nice comment header but it would be nice to access help
online. Thus, I have adopted the convention of coding a "help"
method procedure for every object I write, viz.

myobj = obj_new('myobject')
myobj -> help

Rather than having to duplicate documentation in this method
*and* the code header, can I not simply display the source
header to the user? This approach has the benefit of encouraging
the IDL programmer to write well-documented code headers.
Comments on this convention?

Question: how can I locate the source file assuming that
I know the file name (myobject__define.pro) and that it
is located in the IDL_PATH? (IDL's filepath procedure
gives incorrect info for user written routines.)

Any help is much appreciated.

Cheers,
Darran.

-----== Posted via Deja News, The Leader in Internet Discussion ==-----
http://www.dejanews.com/rg_mkgrp.xp Create Your Own Free Member Forum

Report message to a moderator

[Message index]

		[Object IDL] self-documenting objects ... By: dEdmundson on Fri, 31 July 1998 00:00
		Re: [Object IDL] self-documenting objects ... By: darran on Wed, 05 August 1998 00:00
		Re: [Object IDL] self-documenting objects ... By: mallors on Thu, 06 August 1998 00:00

Previous Topic:	matlab/pv-wave conversion?
Next Topic:	How to specify Y-axis label in LIVE_PLOT?

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Wed Oct 08 17:19:40 PDT 2025

Total time taken to generate the page: 0.00559 seconds