comp.lang.idl-pvwave archive: archive » Re: Comments on Coding Style

Home » Public Forums » archive » Re: Comments on Coding Style

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

Re: Comments on Coding Style [message #70767 is a reply to message #70668]

Thu, 29 April 2010 14:17

Michael Galloy
Messages: 1114
Registered: April 2006

Senior Member

On 4/29/10 2:59 PM, David Fanning wrote:
> Mike Galloy writes:
>
>>>> Also, using one of the standard formats allows the Workbench to show
>>>> the help for the routine.
>>>
>>> How is this done?
>>
>> Nothing needs to be done to turn it on, just write the comments in
>> IDLdoc's rst format.
>
> But how is this accessed from the Workbench?

Ah, just mouse over a call to a routine in the editor. I see something like:

http://michaelgalloy.com/wp-content/uploads/2010/04/vis_conv ert_mouseover.png

VIS_CONVERT has a header like:

;+
; Use ImageMagick to convert a file between formats.
;
; :Params:
; basename : in, optional, type=string
; basename of file to convert (used for output name as well)
;
; :Keywords:
; density : in, optional, type=long, default=300
; density of output image in dots per inch
; scale : in, optional, type=long, default=100
; scale percentage to use
; from_extension : in, optional, type=string
; extension to use for input file
; from_eps : in, optional, type=boolean
; if set, indicates the input is a Encapsulated PostScript file
; from_png : in, optional, type=boolean
; if set, indicates the input is a PNG file
; from_ps : in, optional, type=boolean
; if set, indicates the input is a PostScript file
; max_dimensions : in, optional, type=lonarr(2)
; maximum dimensions for the output image in pixels
; to_extension : in, optional, type=string
; extension to use for output file
; to_eps : in, optional, type=boolean
; if set, indicates the output should a Encapsulated Postscript file
; to_png : in, optional, type=boolean
; if set, indicates the output should a PNG image file
; to_ps : in, optional, type=boolean
; if set, indicates the output should a Postscript file
; command : out, optional, type=string
; convert command
; output : out, optional, type=bytarr
; output image if output format is an image type
; convert_location : in, optional, type=string
; location of the convert command
;-
pro vis_convert, basename, $
density=density, $
max_dimensions=maxDimensions, $
scale=scale, $
from_extension=fromExtension, $
from_eps=fromEps, $
from_png=fromPng, $
from_ps=fromPs, $
to_extension=toExtension, $
to_eps=toEps, $
to_png=toPng, $
to_ps=toPs, $
command=cmd, $
output=output, $
convert_location=convertLocation

Mike
--
www.michaelgalloy.com
Research Mathematician
Tech-X Corporation

Report message to a moderator

[Message index]

		Re: Comments on Coding Style By: David Fanning on Thu, 29 April 2010 13:59
		Re: Comments on Coding Style By: Michael Galloy on Thu, 29 April 2010 13:52
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 13:17
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 13:10
		Re: Comments on Coding Style By: David Fanning on Thu, 29 April 2010 12:42
		Re: Comments on Coding Style By: penteado on Thu, 29 April 2010 12:38
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 12:26
		Re: Comments on Coding Style By: David Fanning on Thu, 29 April 2010 06:05
		Re: Comments on Coding Style By: Maarten[1] on Thu, 29 April 2010 01:44
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 16:30
		Re: Comments on Coding Style By: Michael Galloy on Thu, 29 April 2010 14:17

Previous Topic:	AO, SAO
Next Topic:	Writing *.csv files

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Thu Oct 09 03:30:48 PDT 2025

Total time taken to generate the page: 1.20375 seconds