./toolbox
usage.pro

Last modification date:

Wed Sep 28 13:27:11 2016

usage

procedure usage, proname, [/verbose], [/source]

Print out the usage for a given procedure or function.

If the procedure or function is found in the gbtidl pro tree then get_usage is used to produce the output, otherwise the argument is passed to doc_library.

GBTIDL uses idldoc to create our reference manual. The format used there does not lead to very useful output from doc_library (which simply shows the comment block in the file). get_usage knows what idldoc tags to look for and it formats things accordingly. It can also generate just a single "Usage:" line to remind the user what the syntax of a particular procedure or function is.

Uses

get_usage which_routine

Version

$Id$

Parameters
proname in, required string	The name of the procedure or function.

Keywords
verbose in, optional boolean (def. 0)	When set, a verbose usage is printed.
source in, optional boolean (def. 0)	When set, the entire contents of the relevent .pro file is sent to the terminal through "more". This keyword trumps verbose and no usage information is printed.