Changeset 8f1699f2 for general/prog


Ignore:
Timestamp:
01/25/2013 01:36:11 PM (11 years ago)
Author:
Krejzi <krejzi@…>
Branches:
10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.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, 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:
8bf11809
Parents:
5a464e4d
Message:

Some package updates (see changelog) and minor fixes to other packages' pages.

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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • general/prog/doxygen.xml

    r5a464e4d r8f1699f2  
    77  <!ENTITY doxygen-download-http "http://ftp.stack.nl/pub/doxygen/doxygen-&doxygen-version;.src.tar.gz">
    88  <!ENTITY doxygen-download-ftp  "ftp://ftp.stack.nl/pub/doxygen/doxygen-&doxygen-version;.src.tar.gz">
    9   <!ENTITY doxygen-md5sum        "6fa7baf995fa3f71cfc09e264ba88a83">
    10   <!ENTITY doxygen-size          "5.8 MB">
    11   <!ENTITY doxygen-buildsize     "76 MB">
     9  <!ENTITY doxygen-md5sum        "31b0aaab51c5cab7db9f0ebbe9f85530">
     10  <!ENTITY doxygen-size          "6.0 MB">
     11  <!ENTITY doxygen-buildsize     "86 MB">
    1212  <!ENTITY doxygen-time          "1.4 SBU (includes building the GUI frontend and all docs)">
    1313]>
    … …  
    3030    <title>Introduction to Doxygen</title>
    3131
    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>
     32    <para>
     33      The <application>Doxygen</application> package contains a documentation
     34      system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP,
     35      C# and D. It is useful for generating HTML documentation and/or an
     36      off-line reference manual from a set of documented source files. There
     37      is also support for generating output in RTF, PostScript, hyperlinked
     38      PDF, compressed HTML, and Unix man pages. The documentation is extracted
     39      directly from the sources, which makes it much easier to keep the
     40      documentation consistent with the source code.
     41    </para>
     42
     43    <para>
     44      You can also configure <application>Doxygen</application> to extract
     45      the code structure from undocumented source files. This is very useful
     46      to quickly find your way in large source distributions. Used along with
     47      <application>Graphviz</application>, you can also visualize the relations
     48      between the various elements by means of include dependency graphs,
     49      inheritance diagrams, and collaboration diagrams, which are all generated
     50      automatically.
     51    </para>
    4852
    4953    &lfs72_checked;
    … …  
    5256    <itemizedlist spacing="compact">
    5357      <listitem>
    54         <para>Download (HTTP): <ulink url="&doxygen-download-http;"/></para>
    55       </listitem>
    56       <listitem>
    57         <para>Download (FTP): <ulink url="&doxygen-download-ftp;"/></para>
    58       </listitem>
    59       <listitem>
    60         <para>Download MD5 sum: &doxygen-md5sum;</para>
    61       </listitem>
    62       <listitem>
    63         <para>Download size: &doxygen-size;</para>
    64       </listitem>
    65       <listitem>
    66         <para>Estimated disk space required: &doxygen-buildsize;</para>
    67       </listitem>
    68       <listitem>
    69         <para>Estimated build time: &doxygen-time;</para>
     58        <para>
     59          Download (HTTP): <ulink url="&doxygen-download-http;"/>
     60        </para>
     61      </listitem>
     62      <listitem>
     63        <para>
     64          Download (FTP): <ulink url="&doxygen-download-ftp;"/>
     65        </para>
     66      </listitem>
     67      <listitem>
     68        <para>
     69          Download MD5 sum: &doxygen-md5sum;
     70        </para>
     71      </listitem>
     72      <listitem>
     73        <para>
     74          Download size: &doxygen-size;
     75        </para>
     76      </listitem>
     77      <listitem>
     78        <para>
     79          Estimated disk space required: &doxygen-buildsize;
     80        </para>
     81      </listitem>
     82      <listitem>
     83        <para>
     84          Estimated build time: &doxygen-time;
     85        </para>
    7086      </listitem>
    7187    </itemizedlist>
    … …  
    7490
    7591    <bridgehead renderas="sect4">Optional</bridgehead>
    76     <para role="optional"><xref linkend="qt"/> (for doxywizard),
    77     <xref linkend="graphviz"/>,
    78     <xref linkend="python2"/>, 
    79     <xref linkend="texlive"/>, and
    80     <xref linkend="gs"/></para>
     92    <para role="optional">
     93      <xref linkend="graphviz"/>,
     94      <xref linkend="gs"/>,
     95      <xref linkend="python2"/>,
     96      <xref linkend="qt"/> (for doxywizard) and
     97      <xref linkend="texlive"/>
     98    </para>
    8199
    82100    <para condition="html" role="usernotes">User Notes:
    83     <ulink url="&blfs-wiki;/doxygen"/></para>
    84 
     101      <ulink url="&blfs-wiki;/doxygen"/>
     102    </para>
    85103  </sect2>
    86104
    … …  
    88106    <title>Installation of Doxygen</title>
    89107
    90     <para>Install <application>Doxygen</application> by running the following
    91     commands:</para>
     108    <para>
     109      Install <application>Doxygen</application> by running the following
     110      commands:
     111    </para>
    92112
    93113<screen><userinput>./configure --prefix /usr \
    … …  
    95115make</userinput></screen>
    96116
    97     <para>This package does not come with a test suite.</para>
    98 
    99     <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
     117    <para>
     118      This package does not come with a test suite.
     119    </para>
     120
     121    <para>
     122      Now, as the <systemitem class="username">root</systemitem> user:
     123    </para>
    100124
    101125<screen role="root"><userinput>make install</userinput></screen>
    102126
    103     <para>If you wish to generate and install the package documentation
    104     (note that man pages have already been installed), you must have
    105     <application>Python</application>,
    106     <application>TeX Live</application> (for HTML docs) and
    107     <application>Ghostscript</application> (for PDF docs)
    108     installed, then issue the following command as the
    109     <systemitem class="username">root</systemitem> user:</para>
     127    <para>
     128      If you wish to generate and install the package documentation
     129      (note that man pages have already been installed), you must have
     130      <application>Python</application>,
     131      <application>TeX Live</application> (for HTML docs) and
     132      <application>Ghostscript</application> (for PDF docs)
     133      installed, then issue the following command as the
     134      <systemitem class="username">root</systemitem> user:
     135    </para>
    110136
    111137<screen role="root"><userinput>make install_docs</userinput></screen>
    … …  
    116142    <title>Command Explanations</title>
    117143
    118     <para><option>--with-doxywizard</option>: Use this parameter if
    119     <application>Qt</application> is installed and you wish to build the
    120     GUI front-end.</para>
     144    <para>
     145      <option>--with-doxywizard</option>: Use this parameter if
     146      <application>Qt</application> is installed and you wish to
     147      build the GUI front-end.
     148    </para>
    121149
    122150  </sect2>
    … …  
    125153    <title>Configuring Doxygen</title>
    126154
    127     <para>There is no real configuration necessary for the
    128     <application>Doxygen</application> package although three additional
    129     packages are required if you wish to use extended capabilities. If you need
    130     to use the language translation features, you must have <xref
    131     linkend="python2"/> installed. If you require formulas to create PDF
    132     documentation, then you must have <xref linkend="texlive"/> installed. If
    133     you require formulas to convert PostScript files to bitmaps, then you must
    134     have <xref linkend="gs"/> installed.</para>
     155    <para>
     156      There is no real configuration necessary for the
     157      <application>Doxygen</application> package although three additional
     158      packages are required if you wish to use extended capabilities. If you
     159      need to use the language translation features, you must have <xref
     160       linkend="python2"/> installed. If you require formulas to create PDF
     161      documentation, then you must have <xref linkend="texlive"/> installed.
     162      If you require formulas to convert PostScript files to bitmaps, then
     163      you must have <xref linkend="gs"/> installed.
     164    </para>
    135165
    136166  </sect2>
    … …  
    141171    <segmentedlist>
    142172      <segtitle>Installed Programs</segtitle>
    143       <segtitle>Installed Libraries</segtitle>
    144173      <segtitle>Installed Directory</segtitle>
    145174
    146175      <seglistitem>
    147         <seg>doxygen, doxytag, and optionally, doxywizard</seg>
    148         <seg>None</seg>
    149         <seg>/usr/share/doc/doxygen</seg>
     176        <seg>
     177          doxygen and optionally, doxywizard
     178        </seg>
     179        <seg>
     180          /usr/share/doc/doxygen-&doxygen-version;
     181        </seg>
    150182      </seglistitem>
    151183    </segmentedlist>
    … …  
    159191        <term><command>doxygen</command></term>
    160192        <listitem>
    161           <para>is a command-line based utility used to generate template
    162           configuration files and then generate documentation from these templates. Use
    163           <command>doxygen --help</command> for an explanation of the command-line
    164           parameters.</para>
     193          <para>
     194            is a command-line based utility used to generate template
     195            configuration files and then generate documentation from these
     196            templates. Use <command>doxygen --help</command> for an
     197            explanation of the command-line parameters.
     198          </para>
    165199          <indexterm zone="doxygen doxygen-prog">
    166200            <primary sortas="b-doxygen">doxygen</primary>
    … …  
    169203      </varlistentry>
    170204
    171       <varlistentry id="doxytag">
    172         <term><command>doxytag</command></term>
    173         <listitem>
    174           <para>is used to generate a tag file and/or a search index for a set
    175           of HTML files.</para>
    176           <indexterm zone="doxygen doxytag">
    177             <primary sortas="b-doxytag">doxytag</primary>
    178           </indexterm>
    179         </listitem>
    180       </varlistentry>
    181 
    182205      <varlistentry id="doxywizard">
    183206        <term><command>doxywizard</command></term>
    184207        <listitem>
    185           <para>is a GUI front-end for configuring and
    186           running <command>doxygen</command>.</para>
     208          <para>
     209            is a GUI front-end for configuring and
     210            running <command>doxygen</command>.
     211          </para>
    187212          <indexterm zone="doxygen doxywizard">
    188213            <primary sortas="b-doxywizard">doxywizard</primary>
    … …  
    190215        </listitem>
    191216      </varlistentry>
     217
    192218    </variablelist>
    193219
Note: See TracChangeset for help on using the changeset viewer.