95 lines
3.2 KiB
HTML
95 lines
3.2 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of DOXYGEN</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>DOXYGEN</H1>
|
|
Section: User Commands (1)<BR>Updated: 09-04-2020<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
doxygen - documentation system for various programming languages
|
|
<A NAME="lbAC"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
Doxygen is a documentation system for C++, C, Java, Objective-C, IDL
|
|
(Corba and Microsoft flavors), Fortran, Python, VHDL and to some extent PHP, C#, and D.
|
|
<P>
|
|
|
|
You can use doxygen in a number of ways:
|
|
<DL COMPACT>
|
|
<DT id="1">1) Use doxygen to generate a template configuration file:<DD>
|
|
<DT id="2"><DD>
|
|
doxygen [-s] <B>-g</B> [configName]
|
|
<DT id="3">2) Use doxygen to update an old configuration file:<DD>
|
|
<DT id="4"><DD>
|
|
doxygen [-s] <B>-u</B> [configName]
|
|
<DT id="5">3) Use doxygen to generate documentation using an existing configuration file:<DD>
|
|
<DT id="6"><DD>
|
|
doxygen [configName]
|
|
<DT id="7">4) Use doxygen to generate a template file controlling the layout of the generated documentation:<DD>
|
|
<DT id="8"><DD>
|
|
doxygen -l [layoutFileName]
|
|
<DT id="9"><DD>
|
|
In case layoutFileName is omitted layoutFileName.xml will be used as filename.
|
|
If - is used for layoutFileName doxygen will write to standard output.
|
|
<DT id="10">5) Use doxygen to generate a template style sheet file for RTF, HTML or Latex.<DD>
|
|
<DT id="11"><DD>
|
|
RTF:
|
|
doxygen <B>-w</B> rtf styleSheetFile
|
|
<DT id="12"><DD>
|
|
HTML:
|
|
doxygen <B>-w</B> html headerFile footerFile styleSheetFile [configFile]
|
|
<DT id="13"><DD>
|
|
LaTeX: doxygen <B>-w</B> latex headerFile footerFile styleSheetFile [configFile]
|
|
<DT id="14">6) Use doxygen to generate an rtf extensions file<DD>
|
|
<DT id="15"><DD>
|
|
RTF:
|
|
doxygen <B>-e</B> rtf extensionsFile
|
|
<DT id="16"><DD>
|
|
If - is used for extensionsFile doxygen will write to standard output.
|
|
<DT id="17">7) Use doxygen to compare the used configuration file with the template configuration file<DD>
|
|
<DT id="18"><DD>
|
|
doxygen <B>-x</B> [configFile]
|
|
<DT id="19">8) Use doxygen to show a list of built-in emojis.<DD>
|
|
<DT id="20"><DD>
|
|
doxygen <B>-f</B> emoji outputFileName
|
|
<DT id="21"><DD>
|
|
If - is used for outputFileName doxygen will write to standard output.
|
|
</DL>
|
|
<P>
|
|
|
|
If <B>-s</B> is specified the comments in the config file will be omitted.
|
|
If configName is omitted `Doxyfile' will be used as a default.
|
|
If - is used for configFile doxygen will write / read the configuration to /from standard output / input.
|
|
<A NAME="lbAD"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
Doxygen version 1.8.17, Copyright Dimitri van Heesch 1997-2019
|
|
<A NAME="lbAE"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<A HREF="/cgi-bin/man/man2html?1+doxywizard">doxywizard</A>(1).
|
|
<P>
|
|
|
|
Please consider installing the doxygen-doc package as it contains additional
|
|
documentation on how to use doxygen.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="22"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="23"><A HREF="#lbAC">DESCRIPTION</A><DD>
|
|
<DT id="24"><A HREF="#lbAD">AUTHOR</A><DD>
|
|
<DT id="25"><A HREF="#lbAE">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:11 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|