Changeset a1fd0f2


Ignore:
Timestamp:
07/19/2005 08:48:40 PM (16 years ago)
Author:
Randy McMurchy <randy@…>
Branches:
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
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

Files:
3 edited

Legend:

Unmodified
Added
Removed
  • general.ent

    r58ff87a ra1fd0f2  
    1 <!ENTITY day          "18">
     1<!ENTITY day          "19">
    22<!ENTITY month        "07">
    33<!ENTITY year         "2005">
     
    134134<!-- Chapter 12 -->
    135135<!ENTITY dejagnu-version              "1.4.4">
    136 <!ENTITY doxygen-version              "1.4.2">
     136<!ENTITY doxygen-version              "1.4.3">
    137137<!ENTITY expect-version               "5.43.0">
    138138<!ENTITY gcc-version                  "3.4.3">
  • general/prog/doxygen.xml

    r58ff87a ra1fd0f2  
    55  %general-entities;
    66
    7   <!ENTITY doxygen-download-http " ">
     7  <!ENTITY doxygen-download-http "http://ftp.stack.nl/pub/users/dimitri/doxygen-&doxygen-version;.src.tar.gz">
    88  <!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>)">
     9  <!ENTITY doxygen-md5sum        "6cad81b86c1271777b8ee7c953a496ac">
     10  <!ENTITY doxygen-size          "2.7 MB">
     11  <!ENTITY doxygen-buildsize     "41 MB (additional 6.3 MB to install docs)">
     12  <!ENTITY doxygen-time          "1.4 SBU">
    1313]>
    1414
     
    3030    <title>Introduction to Doxygen</title>
    3131
    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
     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
    3839    documentation consistent with the source code.</para>
    3940
    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
     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
    4344    <application>GraphViz</application>, you can also visualize the relations
    4445    between the various elements by means of include dependency graphs,
     
    7273    <bridgehead renderas="sect4">Optional</bridgehead>
    7374    <para><xref linkend="qt"/>,
    74     <xref linkend="python"/>,
    75     <xref linkend="tex"/>,
    76     <xref linkend="gs"/> or <xref linkend="espgs"/>, and
     75    <xref linkend="tex"/> and
    7776    <ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
    7877
     
    8988make</userinput></screen>
    9089
     90    <para>This package does not come with a test suite.</para>
     91
    9192    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
    9293
    9394<screen role="root"><userinput>make install</userinput></screen>
    9495
    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;
    102 make pdf &amp;&amp;
    103 install -v -d -m755 /usr/share/doc/doxygen/src &amp;&amp;
    104 install -v -m644 src/translator{,_adapter,_en}.h \
    105     /usr/share/doc/doxygen/src &amp;&amp;
    106 install -v -m644 VERSION /usr/share/doc/doxygen &amp;&amp;
    107 make install_docs</userinput></screen>
     96    <para>If you wish to generate and install the package documentation
     97    (note that man pages have already been installed), you must have
     98    <application>TeX</application> installed, then issue the following
     99    command as the <systemitem class="username">root</systemitem> user:</para>
     100
     101<screen role="root"><userinput>make install_docs</userinput></screen>
     102
     103    <tip>
     104      <para>If you don't have <application>TeX</application> installed but
     105      wish to generate and install the HTML documentation (very good docs),
     106      issue the following commands:</para>
     107
     108<screen><userinput>make docs</userinput></screen>
     109
     110      <para>Now, as the <systemitem class="username">root</systemitem>
     111      user:</para>
     112
     113<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/doxygen &amp;&amp;
     114cp -v -R examples html /usr/share/doc/doxygen</userinput></screen>
     115
     116    </tip>
    108117
    109118  </sect2>
     
    116125    <command>make</command> to use this file instead of the system
    117126    installed version. Removing this file allows the GUI front-end to build
    118     successfully.</para>
     127    successfully. This command is not required if you don't pass the
     128    <option>--with-doxywizard</option> parameter (but won't affect the build
     129    otherwise).</para>
    119130
    120131    <para><option>--with-doxywizard</option>: Use this parameter if
     
    122133    GUI front-end.</para>
    123134
    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     <para><emphasis>Note: For documentation in a language other than English,
    135     replace the <quote>_en</quote> with the country code of your
    136     locale.</emphasis></para>
    137 
    138     <para><command>make install_docs</command>: This command installs
    139     the binaries and documentation.</para>
     135  </sect2>
     136
     137  <sect2 role="configuration">
     138    <title>Configuring Doxygen</title>
     139
     140    <para>There is no real configuration necessary for the
     141    <application>Doxygen</application> package although three additional
     142    packages are required if you wish to use extended capabilites. If you
     143    need to use the language translation features, you must have
     144    <xref linkend="python"/> installed. If you require formulas to
     145    create PDF documentation, then you must have <xref linkend="tex"/>
     146    installed. If you require formulas to convert PostScript files to bitmaps,
     147    then you must have <xref linkend="gs"/> or <xref linkend="espgs"/>
     148    installed.</para>
    140149
    141150  </sect2>
     
    150159
    151160      <seglistitem>
    152         <seg>doxygen, doxytag, and doxywizard</seg>
     161        <seg>doxygen, doxytag, and optionally, doxywizard</seg>
    153162        <seg>None</seg>
    154163        <seg>/usr/share/doc/doxygen</seg>
     
    195204        </listitem>
    196205      </varlistentry>
    197 
    198206    </variablelist>
    199207
     
    201209
    202210</sect1>
    203 
  • introduction/welcome/changelog.xml

    r58ff87a ra1fd0f2  
    2525  <itemizedlist>
    2626   
     27    <listitem>
     28      <para>July 19th 2005 [randy]: Updated to Doxygen-1.4.3.</para>
     29    </listitem>
     30
    2731    <listitem>
    2832      <para>July 18th 2005 [randy]: Updated to Nail-11.24 and
Note: See TracChangeset for help on using the changeset viewer.