MGunit documentation

Unit testing for IDL

single page | use frames     summary     class     fields     routine details     file attributes

cmdline_tools/

man.pro

includes main-level program

Prints basic information about a routine.

Examples

Try the main-level example at the end of this file: IDL> .run man This: IDL> man, 'congrid' Filename: /Applications/itt/idl71/lib/congrid.pro result = congrid(arr, x, y, z, CENTER=CENTER, CUBIC=CUBIC, INTERP=INTERP, MINUS_ONE=MINUS_ONE) IDL> man, 'mg_*range*' Filename: /Users/mgalloy/projects/idllib/trunk/src/indices/mg_makerange.pro result = MG_MAKERANGE(startvalue, stopvalue, INCREMENT=INCREMENT, N=N) Filename: /Users/mgalloy/projects/idllib/trunk/src/analysis/mg_range.pro result = MG_RANGE(var)

Other file information

Uses:

mg_termcolumns

Routines

man_resolveroutine, routine [, /resolved] [, _extra=keywords]

Routine to resolve a given routine without crashing.

result = man_width()

Wrapper for MG_TERMCOLUMNS in case it is not available.

man_print, text [, indent=string]

Print a string by splitting it across lines on spaces and indents every line except the first using the value of the INDENT keyword.

result = man_checkroutine(list, routine)

Checks to see if routine is in list.

man_routineinfo, routine

Print comments about a routine.

man, routine

Print comments about a routine or finds matching routines.

Routine details

topman_resolveroutine

man_resolveroutine, routine [, /resolved] [, _extra=keywords]

Routine to resolve a given routine without crashing.

Parameters

routine in required type=string

name of routine to resolve

Keywords

resolved out optional type=boolean

set to a named variable to find out if the routine was resolved

_extra in optional type=keywords

keywords to RESOLVE_ROUTINE

topman_width

result = man_width()

Wrapper for MG_TERMCOLUMNS in case it is not available.

Return value

long

topman_print

man_print, text [, indent=string]

Print a string by splitting it across lines on spaces and indents every line except the first using the value of the INDENT keyword.

Parameters

text

Keywords

indent in optional type=string default=' '

string to prefix each line except the first

topman_checkroutine

result = man_checkroutine(list, routine)

Checks to see if routine is in list.

Return value

1 if routine in in list; 0 if not

Parameters

list in required type=strarr

list of routines to check against

routine in required type=string

name of routine to check (case-insensitive)

topman_routineinfo

man_routineinfo, routine

Print comments about a routine.

Parameters

routine in required type=string

routine name to look up

topman

man, routine

Print comments about a routine or finds matching routines.

Parameters

routine in required type=string

routine name to look up

File attributes

Modification date: Sun Apr 26 20:18:13 2009
Lines: 293
Docformat: rst rst