source: general/prog/doxygen.xml@ 2f5c01ff

10.0 10.1 11.0 11.1 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 qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 2f5c01ff was 2f5c01ff, checked in by Bruce Dubbs <bdubbs@…>, 13 years ago

Update to doxygen-1.5.9

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

  • Property mode set to 100644
File size: 7.3 KB
Line 
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 "33c5598fa6d24cbc55849eaf89652557">
10 <!ENTITY doxygen-size "4.0 MB">
11 <!ENTITY doxygen-buildsize "46 MB">
12 <!ENTITY doxygen-time "1.6 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="qt4"/> (for doxywizard),
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 <note><para>If you have both <xref linkend='qt'/> and <xref linkend='qt4'/>
89 installed, be sure to set the environment variable QTDIR to point to the
90 <application>Qt4</application> top level directory if you add the
91 <option>--with-doxywizard</option> option.</para></note>
92
93 <para>Install <application>Doxygen</application> by running the following
94 commands:</para>
95
96<screen><userinput>./configure --prefix /usr \
97 --docdir /usr/share/doc &amp;&amp;
98make</userinput></screen>
99
100 <para>This package does not come with a test suite.</para>
101
102 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
103
104<screen role="root"><userinput>make install</userinput></screen>
105
106 <para>If you wish to generate and install the package documentation
107 (note that man pages have already been installed), you must have
108 <application>Python</application>, <application>teTeX</application> (for
109 HTML docs) and <application>Ghostscript</application> (for PDF docs)
110 installed, then issue the following command as the
111 <systemitem class="username">root</systemitem> user:</para>
112
113<screen role="root"><userinput>make install_docs</userinput></screen>
114
115 </sect2>
116
117 <sect2 role="commands">
118 <title>Command Explanations</title>
119
120 <para><option>--with-doxywizard</option>: Use this parameter if
121 <application>Qt4</application> is installed and you wish to build the
122 GUI front-end.</para>
123
124 </sect2>
125
126 <sect2 role="configuration">
127 <title>Configuring Doxygen</title>
128
129 <para>There is no real configuration necessary for the
130 <application>Doxygen</application> package although three additional
131 packages are required if you wish to use extended capabilities. If you
132 need to use the language translation features, you must have
133 <xref linkend="python"/> installed. If you require formulas to
134 create PDF documentation, then you must have <xref linkend="tetex"/>
135 installed. If you require formulas to convert PostScript files to bitmaps,
136 then you must have <xref linkend="gs"/> or <xref linkend="espgs"/>
137 installed.</para>
138
139 </sect2>
140
141 <sect2 role="content">
142 <title>Contents</title>
143
144 <segmentedlist>
145 <segtitle>Installed Programs</segtitle>
146 <segtitle>Installed Libraries</segtitle>
147 <segtitle>Installed Directory</segtitle>
148
149 <seglistitem>
150 <seg>doxygen, doxytag, and optionally, doxywizard</seg>
151 <seg>None</seg>
152 <seg>/usr/share/doc/doxygen</seg>
153 </seglistitem>
154 </segmentedlist>
155
156 <variablelist>
157 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
158 <?dbfo list-presentation="list"?>
159 <?dbhtml list-presentation="table"?>
160
161 <varlistentry id="doxygen-prog">
162 <term><command>doxygen</command></term>
163 <listitem>
164 <para>is a command-line based utility used to generate template
165 configuration files and then generate documentation from these templates. Use
166 <command>doxygen --help</command> for an explanation of the command-line
167 parameters.</para>
168 <indexterm zone="doxygen doxygen-prog">
169 <primary sortas="b-doxygen">doxygen</primary>
170 </indexterm>
171 </listitem>
172 </varlistentry>
173
174 <varlistentry id="doxytag">
175 <term><command>doxytag</command></term>
176 <listitem>
177 <para>is used to generate a tag file and/or a search index for a set
178 of HTML files.</para>
179 <indexterm zone="doxygen doxytag">
180 <primary sortas="b-doxytag">doxytag</primary>
181 </indexterm>
182 </listitem>
183 </varlistentry>
184
185 <varlistentry id="doxywizard">
186 <term><command>doxywizard</command></term>
187 <listitem>
188 <para>is a GUI front-end for configuring and
189 running <command>doxygen</command>.</para>
190 <indexterm zone="doxygen doxywizard">
191 <primary sortas="b-doxywizard">doxywizard</primary>
192 </indexterm>
193 </listitem>
194 </varlistentry>
195 </variablelist>
196
197 </sect2>
198
199</sect1>
Note: See TracBrowser for help on using the repository browser.