Previous SAXO Documentation Assistant: Overview Next

Utilities/

xhelp.pro

Display an IDL procedure header using widgets and the widget manager.

xhelp Utilities Widget

xhelp, filename, _EXTRA=_EXTRA

Parameters

filename        in required type: scalar string

It is the name of the procedure or of the function we want to display (with or without .pro at the end). FILENAME should be located in !path. ".pro" suffix will be appended if needed.

Keywords

_EXTRA       

Used to pass keywords to XDISPLAYFILE

Examples

 IDL> xhelp,'plt'

    

Version history

Version

$Id: xhelp.pro 296 2007-09-25 10:51:30Z pinsard $

History

Written By Steve Richards, December 1990 Graceful error recovery, DMS, Feb, 1992. Modified to extract .pro documentation headers, PJR/ESRG mar94 Paul Ricchiazzi jun93 Institute for Computational Earth System Science University of California, Santa Barbara 7/1/99 : legeres modification par Sebastien Masson : utilisation de xdisplayfile, de findfile et de _extra. 6/7/1999: compatibility mac and windows

Known issues

Restrictions

Triggers the XMANAGER if it is not already in use.

 


  Produced by IDLdoc 2.0.