1mxmldoc(1)                       Michael Sweet                      mxmldoc(1)
2
3
4

NAME

6       mxmldoc - mini-xml documentation generator
7

SYNOPSIS

9       mxmldoc --no-output [ filename.xml ] source file(s) ]
10       mxmldoc  [  --footer  footerfile  ]  [  --header headerfile ] [ --intro
11       introfile ] [ --section section ] [ --title title ] [ filename.xml ]  [
12       source file(s) ] > filename.html
13       mxmldoc  [ --footer footerfile ] [ --framed basename ] [ --header head‐
14       erfile ] [ --intro introfile ] [ --section section ] [ --title title  ]
15       [ filename.xml ] [ source file(s) ]
16       mxmldoc --man manpage [ --footer footerfile ] [ --header headerfile ] [
17       --intro introfile ] [ --section section ] [ --title  title  ]  [  file‐
18       name.xml ] [ source file(s) ] > filename.man
19

DESCRIPTION

21       mxmldoc  scans  the  specified C and C++ source files to produce an XML
22       representation of globally accessible classes, constants, enumerations,
23       functions,  structures,  typedefs, unions, and variables - the XML file
24       is updated as necessary. By default, a HTML representation of  the  XML
25       file  is written to the standard output.  Use the --no-output option to
26       disable the HTML output.
27
28       Man page source can be generated using the --man option.
29
30       If no source files are specified then the current XML file is converted
31       to the standard output.
32
33       In  general, any C or C++ source code is handled by mxmldoc, however it
34       was specifically written to handle code with documentation that is for‐
35       matted  according  to  the  CUPS  Developer Guide which is available at
36       "http://www.cups.org/documentation.php".
37

OPTIONS

39       --footer footerfile
40            Inserts the specified file at the bottom of the output  documenta‐
41            tion.
42
43       --framed basename
44            Created  HTML  documentation  using frames - one for the table-of-
45            contents and one for the body.
46
47       --header headerfile
48            Inserts the specified file at the top of the output documentation.
49
50       --intro introfile
51            Inserts the specified file before the table of contents.
52
53       --man manpage
54            Generated a man page instead of HTML documentation.
55
56       --no-output
57            Disables generation of documentation on the standard output.
58
59       --section section
60            Sets the section/keywords in the output documentation.
61
62       --title title
63            Sets the title of the output documentation.
64

SEE ALSO

66       mxml(3), Mini-XML Programmers Manual, http://www.minixml.org/
67

69       Copyright 2003-2008 by Michael Sweet.
70
71
72
7326 January 2008                    Mini-XML                         mxmldoc(1)
Impressum