source: general/prog/doxygen.xml@ 1bbef1e

10.0 10.1 11.0 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 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 1bbef1e was 1bbef1e, checked in by Manuel Canales Esparcia <manuel@…>, 17 years ago

Tagged doxygen.xml

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

  • Property mode set to 100644
File size: 7.4 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 "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 &amp;&amp;
88./configure --prefix /usr --docdir /usr/share/doc &amp;&amp;
89make</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 &amp;&amp;
102make pdf &amp;&amp;
103install -v -d -m755 /usr/share/doc/doxygen/src &amp;&amp;
104install -v -m644 src/translator{,_adapter,_en}.h \
105 /usr/share/doc/doxygen/src &amp;&amp;
106install -v -m644 VERSION /usr/share/doc/doxygen &amp;&amp;
107make 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 <note>
135 <para>For documentation in a language other than English,
136 replace the <quote>_en</quote> with the country code of your
137 locale.</para>
138 </note>
139
140 <para><command>make install_docs</command>: This command installs
141 the binaries and documentation.</para>
142
143 </sect2>
144
145 <sect2 role="content">
146 <title>Contents</title>
147
148 <segmentedlist>
149 <segtitle>Installed Programs</segtitle>
150 <segtitle>Installed Libraries</segtitle>
151 <segtitle>Installed Directory</segtitle>
152
153 <seglistitem>
154 <seg>doxygen, doxytag, and doxywizard</seg>
155 <seg>None</seg>
156 <seg>/usr/share/doc/doxygen</seg>
157 </seglistitem>
158 </segmentedlist>
159
160 <variablelist>
161 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
162 <?dbfo list-presentation="list"?>
163 <?dbhtml list-presentation="table"?>
164
165 <varlistentry id="doxygen-prog">
166 <term><command>doxygen</command></term>
167 <listitem>
168 <para>is a command-line based utility used to generate template
169 configuration files and then generate documentation from these templates. Use
170 <command>doxygen --help</command> for an explanation of the command-line
171 parameters.</para>
172 <indexterm zone="doxygen doxygen-prog">
173 <primary sortas="b-doxygen">doxygen</primary>
174 </indexterm>
175 </listitem>
176 </varlistentry>
177
178 <varlistentry id="doxytag">
179 <term><command>doxytag</command></term>
180 <listitem>
181 <para>is used to generate a tag file and/or a search index for a set
182 of HTML files.</para>
183 <indexterm zone="doxygen doxytag">
184 <primary sortas="b-doxytag">doxytag</primary>
185 </indexterm>
186 </listitem>
187 </varlistentry>
188
189 <varlistentry id="doxywizard">
190 <term><command>doxywizard</command></term>
191 <listitem>
192 <para>is a GUI front-end for configuring and
193 running <command>doxygen</command>.</para>
194 <indexterm zone="doxygen doxywizard">
195 <primary sortas="b-doxywizard">doxywizard</primary>
196 </indexterm>
197 </listitem>
198 </varlistentry>
199
200 </variablelist>
201
202 </sect2>
203
204</sect1>
205
Note: See TracBrowser for help on using the repository browser.