Subversion Repositories svn LFS-FR

Rev

Rev 557 | Blame | Compare with Previous | Last modification | View Log | RSS feed

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
  <!ENTITY gtk-doc-download-ftp  "&gnome-download-ftp;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
  <!ENTITY gtk-doc-md5sum        "b5e268c71fa90aad890cf53715664d0a">
  <!ENTITY gtk-doc-size          "443 Kio">
  <!ENTITY gtk-doc-buildsize     "4.8 Mio">
  <!ENTITY gtk-doc-time          "moins de 0.1 SBU">
]>

<sect1 id="gtk-doc" xreflabel="GTK-Doc-&gtk-doc-version;">
  <?dbhtml filename="gtk-doc.html"?>

  <sect1info>
    <othername>$LastChangedBy: ken $</othername>
    <date>$Date: 2009-06-27 12:10:28 +0200 (sam 27 jun 2009) $</date>
  </sect1info>

  <title>GTK-Doc-&gtk-doc-version;</title>

  <indexterm zone="gtk-doc">
    <primary sortas="a-GTK-Doc">GTK-Doc</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction à GTK-Doc</title>

    <para>Le paquet <application>GTK-Doc</application> contient
    un documentateur de code. C'est utile pour extraire des commentaires spécialement
    formatés du code pour créer des documentations d'API. Ce paquet
    est <emphasis>facultatif</emphasis>&nbsp;; si vous ne l'installez pas, les paquets
    ne construiront pas la documentation. Cela ne veut pas dire que vous n'aurez
    aucune documentation. Si <application>GTK-Doc</application> n'est pas
    disponible, le processus d'installation copiera toute la
    documentation préconstruite sur votre système.</para>

    <bridgehead renderas="sect3">Informations sur le paquet</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Téléchargement (HTTP)&nbsp;: <ulink url="&gtk-doc-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Téléchargement (FTP)&nbsp;: <ulink url="&gtk-doc-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Somme de contrôle MD5 du téléchargement&nbsp;: &gtk-doc-md5sum;</para>
      </listitem>
      <listitem>
        <para>Taille du téléchargement&nbsp;: &gtk-doc-size;</para>
      </listitem>
      <listitem>
        <para>Estimation de l'espace disque requis&nbsp;: &gtk-doc-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimation du temps de construction&nbsp;: &gtk-doc-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>

    <bridgehead renderas="sect4">Requises</bridgehead>
    <para role="required"><xref linkend="gnome-doc-utils"/>,
    <xref linkend="DocBook"/> et
    <xref linkend="docbook-xsl"/></para>

    <bridgehead renderas="sect4">Recommandées</bridgehead>
    <para role="optional"><xref linkend="python"/></para>

    <bridgehead renderas="sect4">Facultatives</bridgehead>
    <para role="optional"><xref linkend="pkgconfig"/>,
    <xref linkend="scrollkeeper"/>,
    <xref linkend="openjade"/>,
    <xref linkend="sgml-dtd"/>,
    <xref linkend="docbook-dsssl"/>, also
    <xref linkend="glib2"/> (for the testsuite)</para>

    <para condition="html" role="usernotes">Notes utilisateur&nbsp;:
    <ulink url="&blfs-wiki;/gtk-doc"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation de GTK-Doc</title>

    <para>Installez <application>GTK-Doc</application> dn lançant
    les commandes suivantes&nbsp;:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>Maintenant, en tant qu'utilisateur <systemitem class="username">root</systemitem>&nbsp;:</para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>La suite de tests exige que le paquet ait été d'abord installé, mais
    il n'y a aucune de raison de la lancer car il manque un fichier qui fait
    échouer la suite de tests. Si vous tenez à voir les résultats, et si vous êtes un utilisateur
    non privilégié, lancez&nbsp;: <command>make check</command>.</para>

  </sect2>

<!--  <sect2 role="commands">
   <title>Explication des commandes</title>

   \<\!\-\- no scrollkeeper files with this version
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
   href="../../xincludes/scrollkeeper-dir.xml"/> \-\-\>

 </sect2> -->

  <sect2 role="content">
    <title>Contenu</title>

    <segmentedlist>
      <segtitle>Programmes installés</segtitle>
      <segtitle>Bibliothèques installées</segtitle>
      <segtitle>Répertoires installés</segtitle>

      <seglistitem>
        <seg>gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb,
        gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mktmpl, gtkdoc-rebase, gtkdoc-scan,
        gtkdoc-scangobj, et gtkdoc-scanobj</seg>
        <seg>Aucune</seg>
        <seg>Les sous-répertoires suivants de /usr/share/&nbsp;:
        <!--doc/gtk-doc-&gtk-doc-version;, -->
        gnome/help/gtk-doc-manual,
        gtk-doc/data et
        {omf,sgml}/gtk-doc</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Descriptions courtes</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="gtkdoc">
        <term><command>gtkdoc*</command></term>
        <listitem>
          <para>ce sont tout des scripts shell, <application>Perl</application>, ou
          <application>Python</application> utilisés par les scripts
          <filename>Makefile</filename> du paquet pour générer la
          documentation du paquet qui va être construit.</para>
          <indexterm zone="gtk-doc gtkdoc">
            <primary sortas="b-gtkdoc*">gtkdoc*</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>