./toolbox
get_usage.pro

Last modification date:

Wed Sep 28 13:27:11 2016

Routine Summary  6 routines

function get_usage(filename, [method=string], [/verbose])
Parses comment lines like this one to create a sensible usage statement.

function get_usage_lines(filename, method_line, method=method)

function construct_usage_from_lines(lines, method_line, verbose=verbose)

function parse_tag_line(tag_line)

function parse_param_line(tag_line, key)

function strip_line_of_html(line)

Routine Details

get_usage

function get_usage(filename, [method=string], [/verbose])

Parses comment lines like this one to create a sensible usage statement. Remember that more then one method can reside in a single .pro file, so the method keyword may be needed.

Returns

the usage as a vector of strings. See usage for an example where this function is used.

Version

$Id$

Common blocks

examples_text

Parameters
filename in, required string	full path name to the .pro file whose comments are to be parsed

Keywords
method in, optional string	the name of the method whose comments are to be parsed.
verbose in, optional boolean	if not set, just the one line usage statement is returned, if set, full comments, parameter descriptions and other methods used list are also returned.

get_usage_lines

function get_usage_lines(filename, method_line, method=method)

Parameters
filename	.
method_line	.

Keywords
method	.

construct_usage_from_lines

function construct_usage_from_lines(lines, method_line, verbose=verbose)

Common blocks

examples_text

parse_tag_line

function parse_tag_line(tag_line)

Parameters
tag_line	.

parse_param_line

function parse_param_line(tag_line, key)

Parameters
tag_line	.
key	.

strip_line_of_html

function strip_line_of_html(line)

Parameters
line	.