NAME
arg_glossary - Generate an argument table glossary
SYNOPSIS
#include <argtable.h>
const char *arg_glossary(const arg_rec *argtable, int n, const char *prefix);
PARAMETERS
-
const arg_rec *argtable
-
Ptr to argument table.
-
int n
-
Number of entries in argtable[].
-
const char *prefix
-
A string to be prefixed to each line of the output.
DESCRIPTION
Returns a pointer to an internal 'glossary' string which
contains a multi-line description of each of the argument table
entres that have a non-NULL <description> field.
The contents of the glossary string remain unaltered up until the
next invocation of this function.
Each line of the glossary string is formatted as
"<Prefix><tag><name><description>"
The 'prefix' string is useful for adding indenting spaces
before each line in the description to improve the look of
the glossary string, or it can be given as NULL in which
case it is ignored.
Any NULL <tag> fields in the argument table will appear in the
glosssary as empty strings.
Any NULL <name> fields will be substituted by a description of
that argument's data type, enclosed in angled brackets, as in
<int> and <double>.
A name can effectively be suppressed from the glossary by defining
it as an empty string in the argument table.
SEE ALSO
arg_catargs
,
arg_dump
,
arg_record
,
arg_scanargv
,
arg_scanstr
,
arg_syntax
,
arg_typestr