1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY doxygen-download-http "http://ftp.stack.nl/pub/users/dimitri/doxygen-&doxygen-version;.src.tar.gz">
|
---|
8 | <!ENTITY doxygen-download-ftp "ftp://ftp.stack.nl/pub/users/dimitri/doxygen-&doxygen-version;.src.tar.gz">
|
---|
9 | <!ENTITY doxygen-md5sum "f2782e5bd31a7d10b092500bf0d96ae2">
|
---|
10 | <!ENTITY doxygen-size "3.5 MB">
|
---|
11 | <!ENTITY doxygen-buildsize "56 MB">
|
---|
12 | <!ENTITY doxygen-time "1.7 SBU (includes building the GUI frontend)">
|
---|
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
|
---|
33 | documentation system for C++, C, Java, Objective-C, Corba IDL and to some
|
---|
34 | extent PHP, C# and D. This is useful for generating HTML documentation
|
---|
35 | and/or an off-line reference manual from a set of documented source files.
|
---|
36 | There is also support for generating output in RTF, PostScript, hyperlinked
|
---|
37 | PDF, compressed HTML, and Unix man pages. The documentation is extracted
|
---|
38 | directly from the sources, which makes it much easier to keep the
|
---|
39 | documentation consistent with the source code.</para>
|
---|
40 |
|
---|
41 | <para>You can also configure <application>Doxygen</application> to extract
|
---|
42 | the code structure from undocumented source files. This is very useful to
|
---|
43 | quickly find your way in large source distributions. Used along with
|
---|
44 | <application>Graphviz</application>, you can also visualize the relations
|
---|
45 | between the various elements by means of include dependency graphs,
|
---|
46 | inheritance diagrams, and collaboration diagrams, which are all generated
|
---|
47 | automatically.</para>
|
---|
48 |
|
---|
49 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
50 | <itemizedlist spacing="compact">
|
---|
51 | <listitem>
|
---|
52 | <para>Download (HTTP): <ulink url="&doxygen-download-http;"/></para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Download (FTP): <ulink url="&doxygen-download-ftp;"/></para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>Download MD5 sum: &doxygen-md5sum;</para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>Download size: &doxygen-size;</para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>Estimated disk space required: &doxygen-buildsize;</para>
|
---|
65 | </listitem>
|
---|
66 | <listitem>
|
---|
67 | <para>Estimated build time: &doxygen-time;</para>
|
---|
68 | </listitem>
|
---|
69 | </itemizedlist>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect3">Doxygen Dependencies</bridgehead>
|
---|
72 |
|
---|
73 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
74 | <para role="optional"><xref linkend="qt"/>,
|
---|
75 | <xref linkend="graphviz"/>,
|
---|
76 | <xref linkend="python"/>,
|
---|
77 | <xref linkend="tetex"/>,
|
---|
78 | <xref linkend="espgs"/> or <xref linkend="gs"/></para>
|
---|
79 |
|
---|
80 | <para condition="html" role="usernotes">User Notes:
|
---|
81 | <ulink url="&blfs-wiki;/doxygen"/></para>
|
---|
82 |
|
---|
83 | </sect2>
|
---|
84 |
|
---|
85 | <sect2 role="installation">
|
---|
86 | <title>Installation of Doxygen</title>
|
---|
87 |
|
---|
88 | <para>Install <application>Doxygen</application> by running the following
|
---|
89 | commands:</para>
|
---|
90 |
|
---|
91 | <screen><userinput>./configure --prefix /usr \
|
---|
92 | --docdir /usr/share/doc &&
|
---|
93 | make</userinput></screen>
|
---|
94 |
|
---|
95 | <para>This package does not come with a test suite.</para>
|
---|
96 |
|
---|
97 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
98 |
|
---|
99 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
100 |
|
---|
101 | <para>If you wish to generate and install the package documentation
|
---|
102 | (note that man pages have already been installed), you must have
|
---|
103 | <application>Python</application>, <application>teTeX</application> (for
|
---|
104 | HTML docs) and <application>Ghostscript</application> (for PDF docs)
|
---|
105 | installed, then issue the following command as the
|
---|
106 | <systemitem class="username">root</systemitem> user:</para>
|
---|
107 |
|
---|
108 | <screen role="root"><userinput>make install_docs</userinput></screen>
|
---|
109 |
|
---|
110 | </sect2>
|
---|
111 |
|
---|
112 | <sect2 role="commands">
|
---|
113 | <title>Command Explanations</title>
|
---|
114 |
|
---|
115 | <para><option>--with-doxywizard</option>: Use this parameter if
|
---|
116 | <application>Qt</application> is installed and you wish to build the
|
---|
117 | GUI front-end.</para>
|
---|
118 |
|
---|
119 | </sect2>
|
---|
120 |
|
---|
121 | <sect2 role="configuration">
|
---|
122 | <title>Configuring Doxygen</title>
|
---|
123 |
|
---|
124 | <para>There is no real configuration necessary for the
|
---|
125 | <application>Doxygen</application> package although three additional
|
---|
126 | packages are required if you wish to use extended capabilities. If you
|
---|
127 | need to use the language translation features, you must have
|
---|
128 | <xref linkend="python"/> installed. If you require formulas to
|
---|
129 | create PDF documentation, then you must have <xref linkend="tetex"/>
|
---|
130 | installed. If you require formulas to convert PostScript files to bitmaps,
|
---|
131 | then you must have <xref linkend="gs"/> or <xref linkend="espgs"/>
|
---|
132 | installed.</para>
|
---|
133 |
|
---|
134 | </sect2>
|
---|
135 |
|
---|
136 | <sect2 role="content">
|
---|
137 | <title>Contents</title>
|
---|
138 |
|
---|
139 | <segmentedlist>
|
---|
140 | <segtitle>Installed Programs</segtitle>
|
---|
141 | <segtitle>Installed Libraries</segtitle>
|
---|
142 | <segtitle>Installed Directory</segtitle>
|
---|
143 |
|
---|
144 | <seglistitem>
|
---|
145 | <seg>doxygen, doxytag, and optionally, doxywizard</seg>
|
---|
146 | <seg>None</seg>
|
---|
147 | <seg>/usr/share/doc/doxygen</seg>
|
---|
148 | </seglistitem>
|
---|
149 | </segmentedlist>
|
---|
150 |
|
---|
151 | <variablelist>
|
---|
152 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
153 | <?dbfo list-presentation="list"?>
|
---|
154 | <?dbhtml list-presentation="table"?>
|
---|
155 |
|
---|
156 | <varlistentry id="doxygen-prog">
|
---|
157 | <term><command>doxygen</command></term>
|
---|
158 | <listitem>
|
---|
159 | <para>is a command-line based utility used to generate template
|
---|
160 | configuration files and then generate documentation from these templates. Use
|
---|
161 | <command>doxygen --help</command> for an explanation of the command-line
|
---|
162 | parameters.</para>
|
---|
163 | <indexterm zone="doxygen doxygen-prog">
|
---|
164 | <primary sortas="b-doxygen">doxygen</primary>
|
---|
165 | </indexterm>
|
---|
166 | </listitem>
|
---|
167 | </varlistentry>
|
---|
168 |
|
---|
169 | <varlistentry id="doxytag">
|
---|
170 | <term><command>doxytag</command></term>
|
---|
171 | <listitem>
|
---|
172 | <para>is used to generate a tag file and/or a search index for a set
|
---|
173 | of HTML files.</para>
|
---|
174 | <indexterm zone="doxygen doxytag">
|
---|
175 | <primary sortas="b-doxytag">doxytag</primary>
|
---|
176 | </indexterm>
|
---|
177 | </listitem>
|
---|
178 | </varlistentry>
|
---|
179 |
|
---|
180 | <varlistentry id="doxywizard">
|
---|
181 | <term><command>doxywizard</command></term>
|
---|
182 | <listitem>
|
---|
183 | <para>is a GUI front-end for configuring and
|
---|
184 | running <command>doxygen</command>.</para>
|
---|
185 | <indexterm zone="doxygen doxywizard">
|
---|
186 | <primary sortas="b-doxywizard">doxywizard</primary>
|
---|
187 | </indexterm>
|
---|
188 | </listitem>
|
---|
189 | </varlistentry>
|
---|
190 | </variablelist>
|
---|
191 |
|
---|
192 | </sect2>
|
---|
193 |
|
---|
194 | </sect1>
|
---|