Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

doxygen (1)

Name

doxygen - documentation system for various programming languages

Synopsis

Please see following description for synopsis

Description

DOXYGEN(1)                       User Commands                      DOXYGEN(1)



NAME
       doxygen - documentation system for various programming languages

DESCRIPTION
       Doxygen  is  a  documentation system for C++, C, Java, Objective-C, IDL
       (Corba and Microsoft flavors) and to some extent PHP, C#, and D.

       You can use doxygen in a number of ways:

       1) Use doxygen to generate a template configuration file:

              doxygen [-s] -g [configName]

              If - is used for configName doxygen will write to standard  out-
              put.

       2) Use doxygen to update an old configuration file:

              doxygen [-s] -u [configName]

       3)  Use  doxygen to generate documentation using an existing configura-
       tion file:

              doxygen [configName]

              If - is used for configName  doxygen  will  read  from  standard
              input.

       4)  Use  doxygen  to generate a template file controlling the layout of
       the generated documentation:

              doxygen -l layoutFileName.xml

       5) Use doxygen to generate a template style sheet file for RTF, HTML or
       Latex.

       RTF:   doxygen -w rtf styleSheetFile

       HTML:  doxygen  -w  html  headerFile footerFile styleSheetFile [config-
              File]

       LaTeX: doxygen -w latex headerFile footerFile  styleSheetFile  [config-
       File]

       6) Use doxygen to generate an rtf extensions file

       RTF:   doxygen -e rtf extensionsFile

       If -s is specified the comments in the config file will be omitted.  If
       configName is omitted `Doxyfile' will be used as a default.

AUTHOR
       Doxygen version @VERSION@, Copyright Dimitri van Heesch 1997-2015


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------------------+
       |ATTRIBUTE TYPE |           ATTRIBUTE VALUE            |
       +---------------+--------------------------------------+
       |Availability   | developer/documentation-tool/doxygen |
       +---------------+--------------------------------------+
       |Stability      | Uncommitted                          |
       +---------------+--------------------------------------+
SEE ALSO
       doxywizard(1).



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source was downloaded from  http://ftp.stack.nl/pub/users/dimitri/doxy-
       gen-1.8.13.src.tar.gz

       Further information about this software can be found on the open source
       community website at http://www.stack.nl/~dimitri/doxygen/index.html.



doxygen @VERSION@                   @DATE@                          DOXYGEN(1)