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 "5e0b6c8854c87e06aaca78c81c5236ec">
|
---|
10 | <!ENTITY doxygen-size "2.8 MB">
|
---|
11 | <!ENTITY doxygen-buildsize "39.7 MB (additional 10.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 | <?dbhtml filename="doxygen.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>Doxygen-&doxygen-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="doxygen">
|
---|
26 | <primary sortas="a-Doxygen">Doxygen</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to Doxygen</title>
|
---|
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
|
---|
38 | documentation consistent with the source code.</para>
|
---|
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
|
---|
46 | automatically.</para>
|
---|
47 |
|
---|
48 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
49 | <itemizedlist spacing="compact">
|
---|
50 | <listitem>
|
---|
51 | <para>Download (HTTP): <ulink url="&doxygen-download-http;"/></para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>Download (FTP): <ulink url="&doxygen-download-ftp;"/></para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>Download MD5 sum: &doxygen-md5sum;</para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>Download size: &doxygen-size;</para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>Estimated disk space required: &doxygen-buildsize;</para>
|
---|
64 | </listitem>
|
---|
65 | <listitem>
|
---|
66 | <para>Estimated build time: &doxygen-time;</para>
|
---|
67 | </listitem>
|
---|
68 | </itemizedlist>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect3">Doxygen Dependencies</bridgehead>
|
---|
71 |
|
---|
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
|
---|
77 | <ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
|
---|
78 |
|
---|
79 | </sect2>
|
---|
80 |
|
---|
81 | <sect2 role="installation">
|
---|
82 | <title>Installation of Doxygen</title>
|
---|
83 |
|
---|
84 | <para>Install <application>Doxygen</application> by running the following
|
---|
85 | commands:</para>
|
---|
86 |
|
---|
87 | <screen><userinput>rm src/unistd.h &&
|
---|
88 | ./configure --prefix /usr --docdir /usr/share/doc &&
|
---|
89 | make</userinput></screen>
|
---|
90 |
|
---|
91 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
92 |
|
---|
93 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
94 |
|
---|
95 | <para>If you wish to generate and install the package documentation (which
|
---|
96 | includes the man pages), ensure the <application>Python</application>,
|
---|
97 | <application>TeX</application> and <application>GraphViz</application>
|
---|
98 | packages are installed, then substitute the following commands for the
|
---|
99 | <command>make install</command> command above:</para>
|
---|
100 |
|
---|
101 | <screen role="root"><userinput>make docs &&
|
---|
102 | make pdf &&
|
---|
103 | install -v -d -m755 /usr/share/doc/doxygen/src &&
|
---|
104 | install -v -m644 src/translator{,_adapter,_en}.h \
|
---|
105 | /usr/share/doc/doxygen/src &&
|
---|
106 | install -v -m644 VERSION /usr/share/doc/doxygen &&
|
---|
107 | make install_docs</userinput></screen>
|
---|
108 |
|
---|
109 | </sect2>
|
---|
110 |
|
---|
111 | <sect2 role="commands">
|
---|
112 | <title>Command Explanations</title>
|
---|
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
|
---|
118 | successfully.</para>
|
---|
119 |
|
---|
120 | <para><option>--with-doxywizard</option>: Use this parameter if
|
---|
121 | <application>Qt</application> is installed and you wish to build the
|
---|
122 | GUI front-end.</para>
|
---|
123 |
|
---|
124 | <para><command>make docs</command>: This command builds the
|
---|
125 | man pages and HTML documentation.</para>
|
---|
126 |
|
---|
127 | <para><command>make pdf</command>: This command builds a
|
---|
128 | PDF version of the <application>Doxygen</application>
|
---|
129 | Manual.</para>
|
---|
130 |
|
---|
131 | <para><command>install ...</command>: These commands install some files
|
---|
132 | required by the documentation installation.</para>
|
---|
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
|
---|
136 | locale.</emphasis></para>
|
---|
137 |
|
---|
138 | <para><command>make install_docs</command>: This command installs
|
---|
139 | the binaries and documentation.</para>
|
---|
140 |
|
---|
141 | </sect2>
|
---|
142 |
|
---|
143 | <sect2 role="content">
|
---|
144 | <title>Contents</title>
|
---|
145 |
|
---|
146 | <segmentedlist>
|
---|
147 | <segtitle>Installed Programs</segtitle>
|
---|
148 | <segtitle>Installed Libraries</segtitle>
|
---|
149 | <segtitle>Installed Directory</segtitle>
|
---|
150 |
|
---|
151 | <seglistitem>
|
---|
152 | <seg>doxygen, doxytag, and doxywizard</seg>
|
---|
153 | <seg>None</seg>
|
---|
154 | <seg>/usr/share/doc/doxygen</seg>
|
---|
155 | </seglistitem>
|
---|
156 | </segmentedlist>
|
---|
157 |
|
---|
158 | <variablelist>
|
---|
159 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
160 | <?dbfo list-presentation="list"?>
|
---|
161 | <?dbhtml list-presentation="table"?>
|
---|
162 |
|
---|
163 | <varlistentry id="doxygen-prog">
|
---|
164 | <term><command>doxygen</command></term>
|
---|
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
|
---|
169 | parameters.</para>
|
---|
170 | <indexterm zone="doxygen doxygen-prog">
|
---|
171 | <primary sortas="b-doxygen">doxygen</primary>
|
---|
172 | </indexterm>
|
---|
173 | </listitem>
|
---|
174 | </varlistentry>
|
---|
175 |
|
---|
176 | <varlistentry id="doxytag">
|
---|
177 | <term><command>doxytag</command></term>
|
---|
178 | <listitem>
|
---|
179 | <para>is used to generate a tag file and/or a search index for a set
|
---|
180 | of HTML files.</para>
|
---|
181 | <indexterm zone="doxygen doxytag">
|
---|
182 | <primary sortas="b-doxytag">doxytag</primary>
|
---|
183 | </indexterm>
|
---|
184 | </listitem>
|
---|
185 | </varlistentry>
|
---|
186 |
|
---|
187 | <varlistentry id="doxywizard">
|
---|
188 | <term><command>doxywizard</command></term>
|
---|
189 | <listitem>
|
---|
190 | <para>is a GUI front-end for configuring and
|
---|
191 | running <command>doxygen</command>.</para>
|
---|
192 | <indexterm zone="doxygen doxywizard">
|
---|
193 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
194 | </indexterm>
|
---|
195 | </listitem>
|
---|
196 | </varlistentry>
|
---|
197 |
|
---|
198 | </variablelist>
|
---|
199 |
|
---|
200 | </sect2>
|
---|
201 |
|
---|
202 | </sect1>
|
---|
203 |
|
---|