r4739 - in trunk/BOOK: . general/prog introduction/welcome

randy at linuxfromscratch.org randy at linuxfromscratch.org
Tue Jul 19 13:48:42 PDT 2005


Author: randy
Date: 2005-07-19 14:48:40 -0600 (Tue, 19 Jul 2005)
New Revision: 4739

Modified:
   trunk/BOOK/general.ent
   trunk/BOOK/general/prog/doxygen.xml
   trunk/BOOK/introduction/welcome/changelog.xml
Log:
Updated to Doxygen-1.4.3

Modified: trunk/BOOK/general/prog/doxygen.xml
===================================================================
--- trunk/BOOK/general/prog/doxygen.xml	2005-07-18 22:08:43 UTC (rev 4738)
+++ trunk/BOOK/general/prog/doxygen.xml	2005-07-19 20:48:40 UTC (rev 4739)
@@ -4,12 +4,12 @@
   <!ENTITY % general-entities SYSTEM "../../general.ent">
   %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">
 ]>
 
 <sect1 id="doxygen" xreflabel="Doxygen-&doxygen-version;">
@@ -29,17 +29,18 @@
   <sect2 role="package">
     <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,
     inheritance diagrams, and collaboration diagrams, which are all generated
@@ -71,9 +72,7 @@
 
     <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>
 
   </sect2>
@@ -88,24 +87,34 @@
 ./configure --prefix /usr --docdir /usr/share/doc &&
 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>
+    <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 docs &&
-make pdf &&
-install -v -d -m755 /usr/share/doc/doxygen/src &&
-install -v -m644 src/translator{,_adapter,_en}.h \
-    /usr/share/doc/doxygen/src &&
-install -v -m644 VERSION /usr/share/doc/doxygen &&
-make install_docs</userinput></screen>
+<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 &&
+cp -v -R examples html /usr/share/doc/doxygen</userinput></screen>
+
+    </tip>
+
   </sect2>
 
   <sect2 role="commands">
@@ -115,29 +124,29 @@
     <application>Flex</application>-2.5.31 which causes
     <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
     <application>Qt</application> is installed and you wish to build the
     GUI front-end.</para>
 
-    <para><command>make docs</command>: This command builds the
-    man pages and HTML documentation.</para>
+  </sect2>
 
-    <para><command>make pdf</command>: This command builds a
-    PDF version of the <application>Doxygen</application>
-    Manual.</para>
+  <sect2 role="configuration">
+    <title>Configuring Doxygen</title>
 
-    <para><command>install ...</command>: These commands install some files
-    required by the documentation installation.</para>
+    <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>
 
-    <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="content">
@@ -149,7 +158,7 @@
       <segtitle>Installed Directory</segtitle>
 
       <seglistitem>
-        <seg>doxygen, doxytag, and doxywizard</seg>
+        <seg>doxygen, doxytag, and optionally, doxywizard</seg>
         <seg>None</seg>
         <seg>/usr/share/doc/doxygen</seg>
       </seglistitem>
@@ -194,10 +203,8 @@
           </indexterm>
         </listitem>
       </varlistentry>
-
     </variablelist>
 
   </sect2>
 
 </sect1>
-

Modified: trunk/BOOK/general.ent
===================================================================
--- trunk/BOOK/general.ent	2005-07-18 22:08:43 UTC (rev 4738)
+++ trunk/BOOK/general.ent	2005-07-19 20:48:40 UTC (rev 4739)
@@ -1,4 +1,4 @@
-<!ENTITY day          "18">
+<!ENTITY day          "19">
 <!ENTITY month        "07">
 <!ENTITY year         "2005">
 <!ENTITY version      "svn-&year;&month;&day;">
@@ -133,7 +133,7 @@
 
 <!-- Chapter 12 -->
 <!ENTITY dejagnu-version              "1.4.4">
-<!ENTITY doxygen-version              "1.4.2">
+<!ENTITY doxygen-version              "1.4.3">
 <!ENTITY expect-version               "5.43.0">
 <!ENTITY gcc-version                  "3.4.3">
 <!ENTITY gcc3-version                 "3.3.4">

Modified: trunk/BOOK/introduction/welcome/changelog.xml
===================================================================
--- trunk/BOOK/introduction/welcome/changelog.xml	2005-07-18 22:08:43 UTC (rev 4738)
+++ trunk/BOOK/introduction/welcome/changelog.xml	2005-07-19 20:48:40 UTC (rev 4739)
@@ -25,6 +25,10 @@
   <itemizedlist>
     
     <listitem>
+      <para>July 19th 2005 [randy]: Updated to Doxygen-1.4.3.</para>
+    </listitem>
+
+    <listitem>
       <para>July 18th 2005 [randy]: Updated to Nail-11.24 and 
       Cyrus-SASL-2.1.21.</para>
     </listitem>




More information about the blfs-book mailing list