Changeset 7cd76d62 for general/prog/doxygen.xml
- Timestamp:
- 05/30/2005 09:38:32 PM (19 years ago)
- Branches:
- 10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 6.1, 6.2, 6.2.0, 6.2.0-rc1, 6.2.0-rc2, 6.3, 6.3-rc1, 6.3-rc2, 6.3-rc3, 7.10, 7.4, 7.5, 7.6, 7.6-blfs, 7.6-systemd, 7.7, 7.8, 7.9, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, basic, bdubbs/svn, elogind, gnome, kde5-13430, kde5-14269, kde5-14686, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, krejzi/svn, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, systemd-11177, systemd-13485, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
- Children:
- 539ace5
- Parents:
- dae2ba0b
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
general/prog/doxygen.xml
rdae2ba0b r7cd76d62 30 30 <title>Introduction to Doxygen</title> 31 31 32 <para>The <application>Doxygen</application> package contains a documentation 33 system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C# and D. 34 This is useful for generating HTML documentation and/or an off-line reference manual 35 from a set of documented source files. There is also support for generating output in RTF, 36 PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation 37 is extracted directly from the sources, which makes it much easier to keep the 32 <para>The <application>Doxygen</application> package contains a documentation 33 system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C# and D. 34 This is useful for generating HTML documentation and/or an off-line reference manual 35 from a set of documented source files. There is also support for generating output in RTF, 36 PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation 37 is extracted directly from the sources, which makes it much easier to keep the 38 38 documentation consistent with the source code.</para> 39 39 40 <para>You can also configure <application>Doxygen</application> to extract the 41 code structure from undocumented source files. This is very useful to quickly 42 find your way in large source distributions. Used along with 43 <application>GraphViz</application>, you can also visualize the relations 44 between the various elements by means of include dependency graphs, 45 inheritance diagrams, and collaboration diagrams, which are all generated 40 <para>You can also configure <application>Doxygen</application> to extract the 41 code structure from undocumented source files. This is very useful to quickly 42 find your way in large source distributions. Used along with 43 <application>GraphViz</application>, you can also visualize the relations 44 between the various elements by means of include dependency graphs, 45 inheritance diagrams, and collaboration diagrams, which are all generated 46 46 automatically.</para> 47 47 … … 71 71 72 72 <bridgehead renderas="sect4">Optional</bridgehead> 73 <para><xref linkend="qt"/>, 74 <xref linkend="python"/>, 75 <xref linkend="tex"/>, 76 <xref linkend="gs"/> or <xref linkend="espgs"/>, and 73 <para><xref linkend="qt"/>, 74 <xref linkend="python"/>, 75 <xref linkend="tex"/>, 76 <xref linkend="gs"/> or <xref linkend="espgs"/>, and 77 77 <ulink url="http://www.graphviz.org/">GraphViz</ulink></para> 78 78 … … 82 82 <title>Installation of Doxygen</title> 83 83 84 <para>Install <application>Doxygen</application> by running the following 84 <para>Install <application>Doxygen</application> by running the following 85 85 commands:</para> 86 86 … … 93 93 <screen role="root"><userinput>make install</userinput></screen> 94 94 95 <para>If you wish to generate and install the package documentation (which 96 includes the man pages), ensure the <application>Python</application>, 95 <para>If you wish to generate and install the package documentation (which 96 includes the man pages), ensure the <application>Python</application>, 97 97 <application>TeX</application> and <application>GraphViz</application> 98 packages are installed, then substitute the following commands for the 98 packages are installed, then substitute the following commands for the 99 99 <command>make install</command> command above:</para> 100 100 … … 112 112 <title>Command Explanations</title> 113 113 114 <para><command>rm src/unistd.h</command>: There is a bug in 115 <application>Flex</application>-2.5.31 which causes 116 <command>make</command> to use this file instead of the system 117 installed version. Removing this file allows the GUI front-end to build 114 <para><command>rm src/unistd.h</command>: There is a bug in 115 <application>Flex</application>-2.5.31 which causes 116 <command>make</command> to use this file instead of the system 117 installed version. Removing this file allows the GUI front-end to build 118 118 successfully.</para> 119 119 120 <para><option>--with-doxywizard</option>: Use this parameter if 121 <application>Qt</application> is installed and you wish to build the 120 <para><option>--with-doxywizard</option>: Use this parameter if 121 <application>Qt</application> is installed and you wish to build the 122 122 GUI front-end.</para> 123 123 124 <para><command>make docs</command>: This command builds the 124 <para><command>make docs</command>: This command builds the 125 125 man pages and HTML documentation.</para> 126 126 127 <para><command>make pdf</command>: This command builds a 127 <para><command>make pdf</command>: This command builds a 128 128 PDF version of the <application>Doxygen</application> 129 129 Manual.</para> 130 130 131 <para><command>install ...</command>: These commands install some files 131 <para><command>install ...</command>: These commands install some files 132 132 required by the documentation installation.</para> 133 133 134 <para><emphasis>Note: For documentation in a language other than English, 135 replace the <quote>_en</quote> with the country code of your 134 <para><emphasis>Note: For documentation in a language other than English, 135 replace the <quote>_en</quote> with the country code of your 136 136 locale.</emphasis></para> 137 137 138 <para><command>make install_docs</command>: This command installs 138 <para><command>make install_docs</command>: This command installs 139 139 the binaries and documentation.</para> 140 140 … … 164 164 <term><command>doxygen</command></term> 165 165 <listitem> 166 <para>is a command-line based utility used to generate template 167 configuration files and then generate documentation from these templates. Use 168 <command>doxygen --help</command> for an explanation of the command-line 166 <para>is a command-line based utility used to generate template 167 configuration files and then generate documentation from these templates. Use 168 <command>doxygen --help</command> for an explanation of the command-line 169 169 parameters.</para> 170 170 <indexterm zone="doxygen doxygen-prog"> … … 177 177 <term><command>doxytag</command></term> 178 178 <listitem> 179 <para>is used to generate a tag file and/or a search index for a set 179 <para>is used to generate a tag file and/or a search index for a set 180 180 of HTML files.</para> 181 181 <indexterm zone="doxygen doxytag"> … … 188 188 <term><command>doxywizard</command></term> 189 189 <listitem> 190 <para>is a GUI front-end for configuring and 190 <para>is a GUI front-end for configuring and 191 191 running <command>doxygen</command>.</para> 192 192 <indexterm zone="doxygen doxywizard">
Note:
See TracChangeset
for help on using the changeset viewer.