NAME

       mxmldoc - mini-xml documentation generator

SYNOPSIS

       mxmldoc --no-output [ filename.xml ] source file(s) ]
       mxmldoc  [  --author  author  ]  [  --body bodyfile ] [ --copyright copyright ] [ --footer
       footerfile ] [  --header  headerfile  ]  [  --section  section  ]  [  --title  title  ]  [
       filename.xml ] [ source file(s) ] > filename.html
       mxmldoc  --framed basename [ --author author ] [ --body bodyfile ] [ --copyright copyright
       ] [ --footer footerfile ] [ --header headerfile ] [ --section section ] [ --title title  ]
       [ filename.xml ] [ source file(s) ]
       mxmldoc  [  --author  author  ]  [  --body bodyfile ] [ --copyright copyright ] [ --footer
       footerfile ] [ --header headerfile ] --man manpage [ --section section ] [ --title title ]
       [ filename.xml ] [ source file(s) ] > filename.man
       mxmldoc  --epub  filename.epub  [  --author  author  ]  [  --body bodyfile ] [ --copyright
       copyright ] [ --coverimage image.png ] [ --docversion version ]  [  --feedname  name  ]  [
       --feedurl  url  ]  [ --footer footerfile ] [ --header headerfile ] [ --section section ] [
       --title title ] [ filename.xml ] [ source file(s) ]

DESCRIPTION

       mxmldoc scans the specified C and C++ source files to produce  an  XML  representation  of
       globally  accessible  classes,  constants,  enumerations, functions, structures, typedefs,
       unions, and variables - the  XML  file  is  updated  as  necessary.  By  default,  a  HTML
       representation  of  the  XML  file is written to the standard output.  Use the --no-output
       option to disable the HTML output.

       Man page source can be generated using the --man option.

       If no source files are specified then the current XML file is converted  to  the  standard
       output.

       In  general,  any  C or C++ source code is handled by mxmldoc, however it was specifically
       written to handle code  with  documentation  that  is  formatted  according  to  the  CUPS
       Developer Guide which is available at "http://www.cups.org/doc/spec-cmp.html".

OPTIONS

       --author "author name"
            Specifies the name of the documentation author.

       --body bodyfile
            Inserts the specified file between the table of contents and references.

       --copyright "copyright text"
            Specifies the copyright text to use.

       --docversion version
            Specifies the version number for the generated documentation.

       --epub filename.epub
            Creates an EPUB book with the specified filename.

       --footer footerfile
            Inserts the specified file at the bottom of the output documentation.

       --framed basename
            Creates  HTML  documentation using frames - one for the table-of-contents and one for
            the body.

       --header headerfile
            Inserts the specified file at the top of the output documentation.

       --man manpage
            Generated a man page instead of HTML documentation.

       --no-output
            Disables generation of documentation on the standard output.

       --section section
            Sets the section/keywords in the output documentation.

       --title title
            Sets the title of the output documentation.

SEE ALSO

       mxml(3), Mini-XML Programmers Manual, https://michaelrsweet.github.io/mxml

COPYRIGHT

       Copyright © 2003-2018 by Michael R Sweet.