Changeset a1fd0f2 for general/prog/doxygen.xml

Timestamp:

07/19/2005 08:48:40 PM (19 years ago)

Author:

Randy McMurchy <randy@…>

Branches:

10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 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, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, krejzi/svn, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, systemd-11177, systemd-13485, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal

Children:

c52af0c

Parents:

58ff87a

Message:

Updated to Doxygen-1.4.3

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

File:

• general/prog/doxygen.xml (modified) (9 diffs)

general/prog/doxygen.xml

@@ -5 +5 @@
   %general-entities;
 
-  <!ENTITY doxygen-download-http " ">
+  <!ENTITY doxygen-download-http "http://ftp.stack.nl/pub/users/dimitri/doxygen-&doxygen-version;.src.tar.gz">
   <!ENTITY doxygen-download-ftp  "ftp://ftp.stack.nl/pub/users/dimitri/doxygen-&doxygen-version;.src.tar.gz">
-  <!ENTITY doxygen-md5sum        "5e0b6c8854c87e06aaca78c81c5236ec">
-  <!ENTITY doxygen-size          "2.8 MB">
-  <!ENTITY doxygen-buildsize     "39.7 MB (additional 10.5 MB to build and install docs and <command>doxywizard</command>)">
-  <!ENTITY doxygen-time          "1.26 SBU (additional 0.50 SBU to build docs and <command>doxywizard</command>)">
+  <!ENTITY doxygen-md5sum        "6cad81b86c1271777b8ee7c953a496ac">
+  <!ENTITY doxygen-size          "2.7 MB">
+  <!ENTITY doxygen-buildsize     "41 MB (additional 6.3 MB to install docs)">
+  <!ENTITY doxygen-time          "1.4 SBU">
 ]>
 
@@ -30 +30 @@
     <title>Introduction to Doxygen</title>
 
-    <para>The <application>Doxygen</application> package contains a documentation
-    system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C# and D.
-    This is useful for generating HTML documentation and/or an off-line reference manual
-    from a set of documented source files. There is also support for generating output in RTF,
-    PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation
-    is extracted directly from the sources, which makes it much easier to keep the
+    <para>The <application>Doxygen</application> package contains a
+    documentation system for C++, C, Java, Objective-C, Corba IDL and to some
+    extent PHP, C# and D. This is useful for generating HTML documentation
+    and/or an off-line reference manual from a set of documented source files.
+    There is also support for generating output in RTF, PostScript, hyperlinked
+    PDF, compressed HTML, and Unix man pages. The documentation is extracted
+    directly from the sources, which makes it much easier to keep the
     documentation consistent with the source code.</para>
 
-    <para>You can also configure <application>Doxygen</application> to extract the
-    code structure from undocumented source files. This is very useful to quickly
-    find your way in large source distributions. Used along with
+    <para>You can also configure <application>Doxygen</application> to extract
+    the code structure from undocumented source files. This is very useful to
+    quickly find your way in large source distributions. Used along with
     <application>GraphViz</application>, you can also visualize the relations
     between the various elements by means of include dependency graphs,
@@ -72 +73 @@
     <bridgehead renderas="sect4">Optional</bridgehead>
     <para><xref linkend="qt"/>,
-    <xref linkend="python"/>,
-    <xref linkend="tex"/>,
-    <xref linkend="gs"/> or <xref linkend="espgs"/>, and
+    <xref linkend="tex"/> and
     <ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
 
@@ -89 +88 @@
 make</userinput></screen>
 
+    <para>This package does not come with a test suite.</para>
+
     <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
 
 <screen role="root"><userinput>make install</userinput></screen>
 
-    <para>If you wish to generate and install the package documentation (which
-    includes the man pages), ensure the <application>Python</application>,
-    <application>TeX</application> and <application>GraphViz</application>
-    packages are installed, then substitute the following commands for the
-    <command>make install</command> command above:</para>
-
-<screen role="root"><userinput>make docs &amp;&amp;
-make pdf &amp;&amp;
-install -v -d -m755 /usr/share/doc/doxygen/src &amp;&amp;
-install -v -m644 src/translator{,_adapter,_en}.h \
-    /usr/share/doc/doxygen/src &amp;&amp;
-install -v -m644 VERSION /usr/share/doc/doxygen &amp;&amp;
-make install_docs</userinput></screen>
+    <para>If you wish to generate and install the package documentation
+    (note that man pages have already been installed), you must have
+    <application>TeX</application> installed, then issue the following
+    command as the <systemitem class="username">root</systemitem> user:</para>
+
+<screen role="root"><userinput>make install_docs</userinput></screen>
+
+    <tip>
+      <para>If you don't have <application>TeX</application> installed but
+      wish to generate and install the HTML documentation (very good docs),
+      issue the following commands:</para>
+
+<screen><userinput>make docs</userinput></screen>
+
+      <para>Now, as the <systemitem class="username">root</systemitem>
+      user:</para>
+
+<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/doxygen &amp;&amp;
+cp -v -R examples html /usr/share/doc/doxygen</userinput></screen>
+
+    </tip>
 
   </sect2>
@@ -116 +125 @@
     <command>make</command> to use this file instead of the system
     installed version. Removing this file allows the GUI front-end to build
-    successfully.</para>
+    successfully. This command is not required if you don't pass the
+    <option>--with-doxywizard</option> parameter (but won't affect the build
+    otherwise).</para>
 
     <para><option>--with-doxywizard</option>: Use this parameter if
@@ -122 +133 @@
     GUI front-end.</para>
 
-    <para><command>make docs</command>: This command builds the
-    man pages and HTML documentation.</para>
-
-    <para><command>make pdf</command>: This command builds a
-    PDF version of the <application>Doxygen</application>
-    Manual.</para>
-
-    <para><command>install ...</command>: These commands install some files
-    required by the documentation installation.</para>
-
-    <para><emphasis>Note: For documentation in a language other than English,
-    replace the <quote>_en</quote> with the country code of your
-    locale.</emphasis></para>
-
-    <para><command>make install_docs</command>: This command installs
-    the binaries and documentation.</para>
+  </sect2>
+
+  <sect2 role="configuration">
+    <title>Configuring Doxygen</title>
+
+    <para>There is no real configuration necessary for the
+    <application>Doxygen</application> package although three additional
+    packages are required if you wish to use extended capabilites. If you
+    need to use the language translation features, you must have
+    <xref linkend="python"/> installed. If you require formulas to
+    create PDF documentation, then you must have <xref linkend="tex"/>
+    installed. If you require formulas to convert PostScript files to bitmaps,
+    then you must have <xref linkend="gs"/> or <xref linkend="espgs"/>
+    installed.</para>
 
   </sect2>
@@ -150 +159 @@
 
       <seglistitem>
-        <seg>doxygen, doxytag, and doxywizard</seg>
+        <seg>doxygen, doxytag, and optionally, doxywizard</seg>
         <seg>None</seg>
         <seg>/usr/share/doc/doxygen</seg>
@@ -195 +204 @@
         </listitem>
       </varlistentry>
-
     </variablelist>
 
@@ -201 +209 @@
 
 </sect1>
-