source: general/prog/doxygen.xml@ ff769b8c

10.0 10.1 11.0 11.1 11.2 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 krejzi/svn lazarus nosym perl-modules plabs/python-mods qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since ff769b8c was ff769b8c, checked in by Manuel Canales Esparcia <manuel@…>, 18 years ago

Updated the XML sources to use DocBook XML DTD-4.4.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3656 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 6.7 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY doxygen-download-http " ">
8 <!ENTITY doxygen-download-ftp "ftp://ftp.stack.nl/pub/users/dimitri/doxygen-&doxygen-version;.src.tar.gz">
9 <!ENTITY doxygen-md5sum "b0ea863bb3ccc757264f784a36519ddb">
10 <!ENTITY doxygen-size "2.7 MB">
11 <!ENTITY doxygen-buildsize "39.7 MB (additional 8.5 MB to build and install docs and <command>doxywizard</command>)">
12 <!ENTITY doxygen-time "1.26 SBU (additional 0.50 SBU to build docs and <command>doxywizard</command>)">
13]>
14
15<sect1 id="doxygen" xreflabel="Doxygen-&doxygen-version;">
16<sect1info>
17<othername>$LastChangedBy$</othername>
18<date>$Date$</date>
19</sect1info>
20<?dbhtml filename="doxygen.html"?>
21<title>Doxygen-&doxygen-version;</title>
22<indexterm zone="doxygen">
23<primary sortas="a-Doxygen">Doxygen</primary></indexterm>
24
25<sect2>
26<title>Introduction to <application>Doxygen</application></title>
27
28<para>The <application>Doxygen</application> package contains a documentation
29system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C#
30and D. This is useful for generating <acronym>HTML</acronym> documentation
31and/or an off-line reference manual from a set of documented source files.
32There is also support for generating output in <acronym>RTF</acronym>,
33PostScript, hyperlinked <acronym>PDF</acronym>, compressed
34<acronym>HTML</acronym>, and Unix man pages. The documentation is extracted
35directly from the sources, which makes it much easier to keep the
36documentation consistent with the source code.</para>
37
38<para>You can also configure <application>Doxygen</application> to extract the
39code structure from undocumented source files. This is very useful to quickly
40find your way in large source distributions. Used along with
41<application>GraphViz</application>, you can also visualize the relations
42between the various elements by means of include dependency graphs,
43inheritance diagrams, and collaboration diagrams, which are all generated
44automatically.</para>
45
46<sect3><title>Package information</title>
47<itemizedlist spacing="compact">
48<listitem><para>Download (HTTP):
49<ulink url="&doxygen-download-http;"/></para></listitem>
50<listitem><para>Download (FTP):
51<ulink url="&doxygen-download-ftp;"/></para></listitem>
52<listitem><para>Download MD5 sum: &doxygen-md5sum;</para></listitem>
53<listitem><para>Download size: &doxygen-size;</para></listitem>
54<listitem><para>Estimated disk space required:
55&doxygen-buildsize;</para></listitem>
56<listitem><para>Estimated build time:
57&doxygen-time;</para></listitem></itemizedlist>
58</sect3>
59
60<sect3><title><application>Doxygen</application> dependencies</title>
61<sect4><title>Optional</title>
62<para><xref linkend="qt"/>,
63<xref linkend="python"/>,
64<xref linkend="tex"/>,
65<xref linkend="gs"/> or <xref linkend="espgs"/>, and
66<ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
67</sect4>
68</sect3>
69
70</sect2>
71
72<sect2>
73<title>Installation of <application>Doxygen</application></title>
74
75<para>Install <application>Doxygen</application> by running the following
76commands:</para>
77
78<screen><userinput><command>rm src/unistd.h &amp;&amp;
79./configure --prefix /usr --docdir /usr/share/doc &amp;&amp;
80make</command></userinput></screen>
81
82<para>Now, as the root user:</para>
83
84<screen><userinput role='root'><command>make install</command></userinput></screen>
85
86<para>If you wish to generate and install the package documentation, ensure
87the Python, TeX and Graphviz packages are installed, then substitute the
88following commands for the <command>make install</command> command above:</para>
89
90<screen><userinput role='root'><command>make docs &amp;&amp;
91make pdf &amp;&amp;
92install -v -d -m755 /usr/share/doc/doxygen/src &amp;&amp;
93install -v -m644 src/translator{,_adapter,_en}.h \
94 /usr/share/doc/doxygen/src &amp;&amp;
95install -v -m644 VERSION /usr/share/doc/doxygen &amp;&amp;
96make install_docs</command></userinput></screen>
97
98</sect2>
99
100<sect2>
101<title>Command explanations</title>
102
103<para><command>rm src/unistd.h</command>: There is a bug in
104<application>Flex</application>-2.5.31 which causes <command>make</command> to
105use this file instead of the system installed version. Removing this file
106allows the <acronym>GUI</acronym> front-end to build successfully.</para>
107
108<para><option>--with-doxywizard</option>: Use this parameter if
109<application>Qt</application> is installed and you wish to build the
110<acronym>GUI</acronym> front-end.</para>
111
112<para><command>make docs</command>: This command builds the
113<acronym>HTML</acronym> documentation.</para>
114
115<para><command>make pdf</command>: This command builds a
116<acronym>PDF</acronym> version of the <application>Doxygen</application>
117Manual.</para>
118
119<para><command>install ...</command>: These commands install some files
120required by the documentation installation.</para>
121
122<para><emphasis>Note: For documentation in a language other than English,
123replace the <quote>_en</quote> with the country code of your
124locale.</emphasis></para>
125
126<para><command>make install_docs</command>: This command installs the binaries
127and documentation.</para>
128
129</sect2>
130
131<sect2>
132<title>Contents</title>
133
134<segmentedlist>
135<segtitle>Installed Programs</segtitle>
136<segtitle>Installed Libraries</segtitle>
137<segtitle>Installed Directory</segtitle>
138
139<seglistitem>
140<seg>doxygen, doxytag and doxywizard</seg>
141<seg>None</seg>
142<seg>/usr/share/doc/doxygen</seg>
143</seglistitem>
144</segmentedlist>
145
146<variablelist>
147<bridgehead renderas="sect3">Short Descriptions</bridgehead>
148<?dbfo list-presentation="list"?>
149
150<varlistentry id="doxygen-prog">
151<term><command>doxygen</command></term>
152<listitem><para>is a command-line based utility used to generate template
153configuration files and then generate documentation from these templates. Use
154<command>doxygen --help</command> for an explanation of the command-line
155parameters.</para>
156<indexterm zone="doxygen doxygen-prog">
157<primary sortas="b-doxygen">doxygen</primary></indexterm>
158</listitem>
159</varlistentry>
160
161<varlistentry id="doxytag">
162<term><command>doxytag</command></term>
163<listitem><para>is used to generate a tag file and/or a search index for a set
164of <acronym>HTML</acronym> files.</para>
165<indexterm zone="doxygen doxytag">
166<primary sortas="b-doxytag">doxytag</primary></indexterm>
167</listitem>
168</varlistentry>
169
170<varlistentry id="doxywizard">
171<term><command>doxywizard</command></term>
172<listitem><para>is a <acronym>GUI</acronym> front-end for configuring and
173running <command>doxygen</command>.</para>
174<indexterm zone="doxygen doxywizard">
175<primary sortas="b-doxywizard">doxywizard</primary></indexterm>
176</listitem>
177</varlistentry>
178</variablelist>
179
180</sect2>
181
182</sect1>
183
Note: See TracBrowser for help on using the repository browser.