Changeset 1bbef1e


Ignore:
Timestamp:
05/04/2005 07:34:43 PM (17 years ago)
Author:
Manuel Canales Esparcia <manuel@…>
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:
9db83697
Parents:
966d312
Message:

Tagged doxygen.xml

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • general/prog/doxygen.xml

    r966d312 r1bbef1e  
    1414
    1515<sect1 id="doxygen" xreflabel="Doxygen-&doxygen-version;">
    16 <sect1info>
    17 <othername>$LastChangedBy$</othername>
    18 <date>$Date$</date>
    19 </sect1info>
    20 <?dbhtml filename="doxygen.html"?>
    21 <title>Doxygen-&doxygen-version;</title>
    22 <indexterm zone="doxygen">
    23 <primary sortas="a-Doxygen">Doxygen</primary></indexterm>
    24 
    25 <sect2>
    26 <title>Introduction to <application>Doxygen</application></title>
    27 
    28 <para>The <application>Doxygen</application> package contains a documentation
    29 system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C#
    30 and D. This is useful for generating <acronym>HTML</acronym> documentation
    31 and/or an off-line reference manual from a set of documented source files.
    32 There is also support for generating output in <acronym>RTF</acronym>,
    33 PostScript, hyperlinked <acronym>PDF</acronym>, compressed
    34 <acronym>HTML</acronym>, and Unix man pages. The documentation is extracted
    35 directly from the sources, which makes it much easier to keep the
    36 documentation consistent with the source code.</para>
    37 
    38 <para>You can also configure <application>Doxygen</application> to extract the
    39 code structure from undocumented source files. This is very useful to quickly
    40 find your way in large source distributions. Used along with
    41 <application>GraphViz</application>, you can also visualize the relations
    42 between the various elements by means of include dependency graphs,
    43 inheritance diagrams, and collaboration diagrams, which are all generated
    44 automatically.</para>
    45 
    46 <sect3><title>Package information</title>
    47 <itemizedlist spacing="compact">
    48 <listitem><para>Download (HTTP):
    49 <ulink url="&doxygen-download-http;"/></para></listitem>
    50 <listitem><para>Download (FTP):
    51 <ulink url="&doxygen-download-ftp;"/></para></listitem>
    52 <listitem><para>Download MD5 sum: &doxygen-md5sum;</para></listitem>
    53 <listitem><para>Download size: &doxygen-size;</para></listitem>
    54 <listitem><para>Estimated disk space required:
    55 &doxygen-buildsize;</para></listitem>
    56 <listitem><para>Estimated build time:
    57 &doxygen-time;</para></listitem></itemizedlist>
    58 </sect3>
    59 
    60 <sect3><title><application>Doxygen</application> dependencies</title>
    61 <sect4><title>Optional</title>
    62 <para><xref linkend="qt"/>,
    63 <xref linkend="python"/>,
    64 <xref linkend="tex"/>,
    65 <xref linkend="gs"/> or <xref linkend="espgs"/>, and
    66 <ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
    67 </sect4>
    68 </sect3>
    69 
    70 </sect2>
    71 
    72 <sect2>
    73 <title>Installation of <application>Doxygen</application></title>
    74 
    75 <para>Install <application>Doxygen</application> by running the following
    76 commands:</para>
    77 
    78 <screen><userinput><command>rm src/unistd.h &amp;&amp;
     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;
    7988./configure --prefix /usr --docdir /usr/share/doc &amp;&amp;
    80 make</command></userinput></screen>
    81 
    82 <para>Now, as the root user:</para>
    83 
    84 <screen><userinput role='root'><command>make install</command></userinput></screen>
    85 
    86 <para>If you wish to generate and install the package documentation (which
    87 includes the man pages), ensure the <application>Python</application>,
    88 <application>TeX</application> and <application>GraphViz</application>
    89 packages are installed, then substitute the following commands for the
    90 <command>make install</command> command above:</para>
    91 
    92 <screen><userinput role='root'><command>make docs &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;
    93102make pdf &amp;&amp;
    94103install -v -d -m755 /usr/share/doc/doxygen/src &amp;&amp;
     
    96105    /usr/share/doc/doxygen/src &amp;&amp;
    97106install -v -m644 VERSION /usr/share/doc/doxygen &amp;&amp;
    98 make install_docs</command></userinput></screen>
    99 
    100 </sect2>
    101 
    102 <sect2>
    103 <title>Command explanations</title>
    104 
    105 <para><command>rm src/unistd.h</command>: There is a bug in
    106 <application>Flex</application>-2.5.31 which causes <command>make</command> to
    107 use this file instead of the system installed version. Removing this file
    108 allows the <acronym>GUI</acronym> front-end to build successfully.</para>
    109 
    110 <para><option>--with-doxywizard</option>: Use this parameter if
    111 <application>Qt</application> is installed and you wish to build the
    112 <acronym>GUI</acronym> front-end.</para>
    113 
    114 <para><command>make docs</command>: This command builds the man pages and
    115 <acronym>HTML</acronym> documentation.</para>
    116 
    117 <para><command>make pdf</command>: This command builds a
    118 <acronym>PDF</acronym> version of the <application>Doxygen</application>
    119 Manual.</para>
    120 
    121 <para><command>install ...</command>: These commands install some files
    122 required by the documentation installation.</para>
    123 
    124 <para><emphasis>Note: For documentation in a language other than English,
    125 replace the <quote>_en</quote> with the country code of your
    126 locale.</emphasis></para>
    127 
    128 <para><command>make install_docs</command>: This command installs the binaries
    129 and documentation.</para>
    130 
    131 </sect2>
    132 
    133 <sect2>
    134 <title>Contents</title>
    135 
    136 <segmentedlist>
    137 <segtitle>Installed Programs</segtitle>
    138 <segtitle>Installed Libraries</segtitle>
    139 <segtitle>Installed Directory</segtitle>
    140 
    141 <seglistitem>
    142 <seg>doxygen, doxytag and doxywizard</seg>
    143 <seg>None</seg>
    144 <seg>/usr/share/doc/doxygen</seg>
    145 </seglistitem>
    146 </segmentedlist>
    147 
    148 <variablelist>
    149 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
    150 <?dbfo list-presentation="list"?>
    151 
    152 <varlistentry id="doxygen-prog">
    153 <term><command>doxygen</command></term>
    154 <listitem><para>is a command-line based utility used to generate template
    155 configuration files and then generate documentation from these templates. Use
    156 <command>doxygen --help</command> for an explanation of the command-line
    157 parameters.</para>
    158 <indexterm zone="doxygen doxygen-prog">
    159 <primary sortas="b-doxygen">doxygen</primary></indexterm>
    160 </listitem>
    161 </varlistentry>
    162 
    163 <varlistentry id="doxytag">
    164 <term><command>doxytag</command></term>
    165 <listitem><para>is used to generate a tag file and/or a search index for a set
    166 of <acronym>HTML</acronym> files.</para>
    167 <indexterm zone="doxygen doxytag">
    168 <primary sortas="b-doxytag">doxytag</primary></indexterm>
    169 </listitem>
    170 </varlistentry>
    171 
    172 <varlistentry id="doxywizard">
    173 <term><command>doxywizard</command></term>
    174 <listitem><para>is a <acronym>GUI</acronym> front-end for configuring and
    175 running <command>doxygen</command>.</para>
    176 <indexterm zone="doxygen doxywizard">
    177 <primary sortas="b-doxywizard">doxywizard</primary></indexterm>
    178 </listitem>
    179 </varlistentry>
    180 </variablelist>
    181 
    182 </sect2>
     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>
    183203
    184204</sect1>
Note: See TracChangeset for help on using the changeset viewer.