# Manuel de GTK-Doc

1.24.1

Manuel utilisateur pour les développeurs contenant les instructions sur l'usage de GTK-Doc.

Chris Lyttle

     chris@wilddev.net

Dan Mueth

     d-mueth@uchicago.edu

Stefan Sauer (Kost)

     ensonic@users.sf.net

Projet GTK-Doc

    gtk-doc-list@gnome.org

2000, 2005 Dan Mueth et Chris Lyttle
2007-2019 Stefan Sauer (Kost)

Permission vous est donnée de copier, distribuer et/ou modifier ce document selon les termes de la licence de documentation libre GNU, version 1.1 ou ultérieure publiée par la Free Software Foundation sans section inaltérable, sans texte de première page de couverture ni texte de dernière page de couverture. Vous trouverez un exemplaire de cette licence en suivant ce lien.

La plupart des noms utilisés par les entreprises pour distinguer leurs produits et services sont des marques déposées. Lorsque ces noms apparaissent dans la documentation GNOME et que les membres du projet de Documentation GNOME sont informés de l'existence de ces marques déposées, soit ces noms entiers, soit leur première lettre est en majuscule.

1.33.0
1 Oct 2020
mc gtk4 version
1.32.1
15 Aug 2019
ss dev version
1.32
15 Aug 2019
ss hotfix release
1.31
05 Aug 2019
ss refactorings and more test coverage
1.30
08 May 2019
ss more test coverage
1.29
28 Aug 2018
ss bug fixes
1.28
24 Mar 2018
ss bug fixes
1.27
07 Dec 2017
ss fine tuning of the python port
1.26
11 Aug 2017
ss portage de tous les outils depuis perl/bash vers python
1.25
21 March 2016
ss corrections d'anomalies, nettoyages de test
1.24
29 May 2015
ss corrections d'anomalies
1.23
17 May 2015
ss corrections d'anomalies
1.22
07 May 2015
ss corrections d'anomalies, abandon de fonctionnalités obsolètes
1.21
17 Jul 2014
ss corrections d'anomalies, abandon de fonctionnalités obsolètes
1.20
16 Feb 2014
ss bug fixes, markdown support, style improvements
1.19
05 Jun 2013
ss corrections d'anomalies
1.18
14 Sep 2011
ss correction de bogues, amélioration de la vitesse de traitement, prise en charge de markdown
1.17
26 février 2011
sk mise à jour pour une correction de bogue urgente
1.16
14 janvier 2011
sk correctifs et améliorations de mise en page
1.15
21 mai 2010
sk corrections d'anomalies et de régressions
1.14
28 mars 2010
sk correctifs et amélioration de performances
1.13
18 décembre 2009
sk mise à jour du tarball brisé
1.12
18 décembre 2009
sk nouvelles fonctionnalités aux outils et résolution de bogues
1.11
16 novembre 2008
mal Migration à GNOME doc-utils
Yannick Tailliez ytdispatch-libre02@yahoo.com
2009 Yannick Tailliez
Frédéric Péters fpeters@0d.be
2009 Frédéric Péters
Bruno Brouard annoa.b@gmail.com
2010 2012 Bruno Brouard
Claude Paroz claude@2xlibre.net
2010 Claude Paroz
Gérard Baylard Geodebay@gmail.com
2010 Gérard Baylard
Luc Pionchon pionchon.luc@gmail.com
2011 Luc Pionchon

## Introduction

Ce chapitre présente GTK-Doc et fournit un aperçu de ce que c'est et de la manière de l'utiliser.

### Qu'est-ce que GTK-Doc ?

GTK-Doc is used to document C code. It is typically used to document the public API of libraries, such as GLib-based libraries, but it can also be used to document application code.

### Fonctionnement de GTK-Doc ?

GTK-Doc works by reading specially-formatted comment blocks placed inside the source files to document symbols such as functions, macros, structs, enums, etc. (though note that for most kind of symbols GTK-Doc will only document the symbols that are declared in header files; for example it won't produce output for static functions).

GTK-Doc also reads template files where documentation can be added there as well.

GTK-Doc consists of a number of programs, each performing a different step in the process.

The main steps are:

1. Writing the documentation. The author fills in the source files with the documentation for each function, macro, structs or unions, etc.

2. Collecte des informations sur le code. gtkdoc-scan analyse les fichiers d'en-tête du code à la recherche des déclarations de fonctions, de macros, d'énumérations, de structures et d'unions. Il crée le fichier `<module>-decl-list.txt` contenant une liste des déclarations en les plaçant dans des sections en accord avec le fichier d'en-tête d'où elles proviennent. Lors du premier lancement, ce fichier est copié dans `<module>-sections.txt`. L'auteur peut réorganiser les sections et l'ordre des déclarations dans celui-ci, pour obtenir l'ordre final souhaité. Le deuxième fichier généré est `<module>-decl.txt`. Ce fichier contient les déclarations complètes trouvées lors de l'analyse. Si, pour une raison quelconque, on souhaite voir apparaître dans la documentation des éléments qui n'ont pas été trouvé lors de l'analyse, ou dont la déclaration doit apparaître différemment, il est possible d'ajouter des entrées dans `<module>-overrides.txt` similaires à celle de `<module>-decl.txt`.

   gtkdoc-scanobj peut aussi être utilisé pour interroger de manière dynamique une bibliothèque à propos de n'importe quelle sous-classe de GtkObject qu'elle exporte. Il enregistre les informations sur la position de chaque objet dans la hiérarchie de classe et sur tous les arguments et signaux GTK fournis.

   gtkdoc-scanobj should not be used anymore. It was needed in the past when GObject was still GtkObject inside GTK.

3. Generating the XML and HTML/PDF. gtkdoc-mkdb turns the template files into XML files in the `xml/` subdirectory. If the source code contains documentation for symbols, using the special comment blocks, it gets merged in here. If there are no tmpl files used it only reads docs from sources and introspection data.

   gtkdoc-mkhtml turns the XML files into HTML files in the `html/` subdirectory. Likewise gtkdoc-mkpdf turns the XML files into a PDF document called `<package>.pdf`.

   Les fichiers dans les répertoires `xml/` et `html/` sont toujours écrasés. Il ne faut pas les modifier directement.

4. Fixing up cross-references between documents. After installing the HTML files, gtkdoc-fixxref can be run to fix up any cross-references between separate documents. For example, the GTK documentation contains many cross-references to types documented in the GLib manual.

   When creating the source tarball for distribution, gtkdoc-rebase turns all external links into web-links. When installing distributed (pregenerated) docs the same application will try to turn links back to local links (where those docs are installed).

### Obtention de GTK-Doc

#### Pré-requis

python 2/3 - les principaux scripts sont écrits en Python.

xsltproc - the xslt processor from libxslt xmlsoft.org/XSLT/

docbook-xsl - the docbook xsl stylesheets sourceforge.net/projects/docbook/files/docbook-xsl

One of source-highlight, highlight or vim - optional - used for syntax highlighting of examples

### À propos de GTK-Doc

Historically GTK-Doc was used to generate template files from the sources code. These template files could be used by developers to enter the API documentation. This approach was rather inconvenient because it required to keep the generated files under version control. Since GTK-Doc 1.9 it became possible to place all API information into source comments, which made the template support obsolete. In version 1.26 template support has been removed.

(À COMPLETER)

(authors, web pages, mailing list, license, future plans, comparison with other similar systems.)

### À propos de ce manuel

(À COMPLETER)

(qui est concerné, où le récupérer, licence)

## Project Setup

This Chapter describes the steps that are necessary to integrate GTK-Doc into your project. The integration of GTK-Doc into a project includes the following steps:

- Preparation of the directory structure and creating required configuration files for your GTK-Doc documentation (see Setting up a skeleton documentation).

- Adjusting the build system to build your documentation using the GTK-Doc tools. Multiple build systems are supported, in this manual we describe how to integrate GTK-Doc with Autotools, CMake, and plain Makefiles.

- Adding GTK-Doc specific files to version control and deciding which files to ignore (see Integration with version control systems).

The following sections assume we work on a project called `meep`. This project contains two packages (or modules), a library called `libmeep` and an end-user app called `meeper`.

### Mise en place du squelette de documentation

A common convention is to place documentation into a folder called `docs` inside your top-level project directory. We usually distinguish between reference documentation intended for developers and an user manual intended for end-users. Again the convention is to have separate folders for both. We usually place the reference documentation in a folder named `reference` and the end-user manual in a folder named `help` as. According to the above convention the documentation for our `libmeep` package would be placed into: `docs/reference/libmeep`. For packages with just one library or application the documentation could also be placed directly into `docs/reference`. It is not mandatory to use the above convention, but if you choose to use a different directory structure you must adjust your build system configuration to match your directory structure.

In the following sections we will assume a directory structure for our meep project that uses the above conventions.

Example directory structure of meep project

    meep/
      docs/
        reference/  # reference documentation
          libmeep/
          meeper/
        help/       # optional: user manual
          meeper/
      src/
        libmeep/
        meeper/

### Integration with Autotools

Integration of GTK-Doc into an autotools-based build system requires the following steps:

- Ensure that gtkdocize is run once before the `configure` script. If an `autogen.sh` script is present, adjust it to check for GTK-Doc and add a call to gtkdocize.

  The main purpose of gtkdocize is to make the `gtk-doc.make` Makefile and the `gtk-doc.m4` macro definition file available to the build system, either by copying or linking it into the project.

- Add the necessary autoconf macros to `configure.ac` to enable GTK-Doc in your build system to allow configuration of GTK-Doc via the generated `configure` script.

  Among others with registers the `--enable-gtk-doc` option with the `configure` script.

- Create an automake script for each application or library in your project. In the example used in this documentation this step applies to both `meeper` and `libmeep`.

In the following sections, we will perform the above steps in reverse order. We start with the automake scripts and work our way up to `configure.ac` and `autogen.sh`. Then we show how enable Gtk-Doc in the build system and how to build the documentation.

#### Intégration avec automake

First copy the `Makefile.am` from the `examples` sub-directory of the gtkdoc-sources to your project's reference documentation directory (e.g. `docs/reference/<package>`). A local copy should be available under e.g. `/usr/share/doc/gtk-doc-tools/examples/Makefile.am`. If you have multiple packages repeat this for each one.

Do not forget to add each `Makefile.am` to the `AC_CONFIG_FILES` macro in `configure.ac`. For `docs/reference/libmeep/Makefile.am` you will need to add the entry `docs/reference/libmeep/Makefile` to `AC_CONFIG_FILES`.

Example directory structure with `Makefiles.am`

    meep/
      docs/
        reference/  # reference documentation
          libmeep/
            Makefile.am
          meeper/
            Makefile.am
        help/       # optional: user manual
          meeper/
      src/
        libmeep/
        meeper/

Next, you need to customize the copied Makefiles and provide values for the various parameters in each `Makefile.am`. All settings have a comment above them that describes their purpose and how to customize the setting. Most settings are used to supply extra flags to the respective tools to which they apply. Every tool has a variable of the form `<TOOLNAME>_OPTIONS` (e.g. the tool gtkdoc-mkhtml has an option named `MKHTML_OPTIONS`). All the tools support `--help` to list the supported options.

The following list explains the most relevant options. Check the example `Makefile.am` for additional options.

- `DOC_MODULE` is used to provide the name of the package that is being documentated (e.g. `meeper`, or `libmeep`).

- `DOC_SOURCE_DIR` is used to specify the location of source directory which GTK-Doc searches for your API documentation. This will usually be `DOC_SOURCE_DIR=$(top_srcdir)/src` or a sub-directory of that directory.

- `HFILE_GLOB` and `CFILE_GLOB` are used for dependencies. Each option take a file-glob (e.g. `HFILE_GLOB=$(top_srcdir)/src/*.c`). The documentation will be rebuilt if any of the matched files change.

- `EXTRA_HFILES` allows to specify extra header files to include when scanning for API documentation, which are not found under `DOC_SOURCE_DIR` (e.g. `EXTRA_HFILES=$(top_srcdir}/contrib/extra.h`).

- `IGNORE_HFILES` allows to specify header files or directories to ignore when scanning for API documentation. Use the basename of the file or directory (e.g. `IGNORE_HFILES=gtkdebug.h gtkintl.h private_code_folder`).

- `HTML_IMAGES` allows to specify images files which will be copied into the `html/` directory of the generated documentation. If your API documentation includes any images they need to be added to this option (e.g. `HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png`).

- `content_files` allows to specify extra files that are included by `$(DOC_MAIN_SGML_FILE)` (e.g. `content_files=running.xml building.xml changes-2.0.xml`).

- `expand_content_files` allows to specify files where gtk-doc abbreviations such as `#GtkWidget` are expanded (e.g. `expand_content_files=running.xml`).

#### Intégration avec autoconf

Integration with autoconf is very simple and includes one required step and an additional optional (but recommended) step. The first step is to add the `GTK_DOC_CHECK` macro to your `configure.ac` script. This registers several configure options to enable GTK-Doc and allows you to set default arguments for gtkdocize.

Make sure that the `GTK_DOC_CHECK` macro is not indented. The macro must start at the beginning of the line and should not start with whitespace.

The second step is to add the `AC_CONFIG_MACRO_DIR(m4)` to your `configure.ac`. This is not required but helps gtkdocize to automatically copy the macro definition (e.g `gtk-doc.m4`) which contains the `GTK_DOC_CHECK` macro to your project's macro directory. Without this, the GTK_DOC_CHECK macro might not be found and you would need to explicitly tell the aclocal tool where to find the macro definition file.

Minimal integration with autoconf

    # recommended: set m4 directory
    AC_CONFIG_MACRO_DIR(m4)
    # optional: register gtk-doc in configure
    GTK_DOC_CHECK([1.28])

The above example works, but will require all developers to have gtk-doc installed. A better way is to make building the documentation optional as shown in the next example:

Integration with optional gtk-doc dependency

    m4_ifdef([GTK_DOC_CHECK], [
    # recommended: set m4 directory
    AC_CONFIG_MACRO_DIR(m4)
    # optional: register gtk-doc in configure
    GTK_DOC_CHECK([1.28])
    ],[
    AM_CONDITIONAL([ENABLE_GTK_DOC], false)
    ])

The first argument is used to check for the Gtk-Doc version at configure time. The 2nd, optional argument is used by gtkdocize. The GTK_DOC_CHECK macro also adds several configure switches:

1. --with-html-dir=CHEMIN : répertoire d'installation de la documentation,

2. --enable-gtk-doc : utilisation de gtk-doc pour construire la documentation [par défaut=no],

3. --enable-gtk-doc-html : construction de la documentation au format html [par défaut=yes],

4. --enable-gtk-doc-pdf : build documentation in pdf format [default=no]

GTK-Doc est désactivé par défaut ! N'oubliez pas de passer l'option `'--enable-gtk-doc'` lors de la prochaine exécution du script `configure`. Dans le cas contraire, la documentation pré-générée est installée (ce qui a du sens pour les utilisateurs mais pas pour les développeurs).

After all changes to `configure.ac` are made, update the `configure` file. This can be done by re-running `autogen.sh`.

#### Intégration avec autogen

Most projects will have an `autogen.sh` script to setup the build infrastructure after the project was checked out from a version control system (such as git or svn). GTK-Doc comes with a script called gtkdocize which can be used to copy the necessary files needed by Gtk-Doc to the source directory.

It should be run before autoreconf, autoheader, automake or autoconf.

Exécution de gtkdocize depuis autogen.sh

    gtkdocize || exit 1

Conditionally run gtkdocize from autogen.sh

    GTKDOCIZE=$(which gtkdocize 2>/dev/null)
    if test $? -ne 0; then
      echo "No gtk-doc support found. You can't build the docs."
    else
      $GTKDOCIZE || exit 1
    fi

When running gtkdocize it copies `gtk-doc.make` to your project root (or any directory specified by the `--docdir` option).

gtkdocize checks your `configure.ac` script for the `GTK_DOC_CHECK` macro. The `GTK_DOC_CHECK` macro can be used to pass extra arguments to the gtkdocize script. the 2nd parameter in the `GTK_DOC_CHECK` macro.

Alternatively, additional arguments can also be passed to gtkdocize via the `GTKDOCIZE_FLAGS` environment variable, or by directly specifying them to gtkdocize in `autogen.sh`.

#### Executing GTK-Doc from the Build System

Après toutes ces étapes, il est temps de lancer la construction. Tout d'abord, il faut relancer `autogen.sh`. Si ce script lance « configure » pour vous, alors il faut ajouter l'option `--enable-gtk-doc`, sinon lancez manuellement `configure` suivi de cette option.

La première exécution de make génère plusieurs fichiers supplémentaires dans les répertoires de documentation (doc-directories). Les plus importants sont : `<paquet>.types`, `<paquet>-docs.xml` (anciennement .sgml), `<paquet>-sections.txt`.

Lancement de la construction de la documentation

    ./autogen.sh --enable-gtk-doc
    make

Now you can point your browser to `docs/reference/<package>/index.html`. With this initial setup you will only see a very simple document. The next chapter will teach you how to add API documentation to your code via special comment blocks. The Chapter afterwards introduces additional files and shows how to edit the master template to add additional chapters and sections to your documentation files.

### Integration with CMake build systems

GTK-Doc now provides a `GtkDocConfig.cmake` module (and the corresponding `GtkDocConfigVersion.cmake` module). This provides a `gtk_doc_add_module` command that you can set in your `CMakeLists.txt` file.

L'exemple suivant montre comment utiliser cette commande.

Exemple d'utilisation de GTK-Doc depuis CMake

    find_package(GtkDoc 1.25 REQUIRED)

    # Create the doc-libmeep target.
    gtk_doc_add_module(
       libmeep ${CMAKE_SOURCE_DIR}/libmeep
          XML meep-docs.xml
          LIBRARIES libmeep
    )

    # Build doc-libmeep as part of the default target. Without this, you would
    # have to explicitly run something like `make doc-libmeep` to build the docs.
    add_custom_target(documentation ALL DEPENDS doc-libmeep)

    # Install the docs. (This assumes you're using the GNUInstallDirs CMake module
    # to set the CMAKE_INSTALL_DOCDIR variable correctly).
    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libmeep/html
            DESTINATION ${CMAKE_INSTALL_DOCDIR})

### Intégration avec des « makefiles » simples et d'autres systèmes de compilation

Dans les cas où l'emploi de automake n'est pas souhaité et donc sans fichier `gtk-doc.mak`, il s'agit alors d'appeler les outils gtkdoc dans le bon ordre dans les fichiers « makefiles » ad hoc (ou d'autres systèmes).

Étapes de construction de la documentation

    DOC_MODULE=meep
    // sources have changed
    gtkdoc-scan --module=$(DOC_MODULE) <source-dir>
    gtkdoc-scangobj --module=$(DOC_MODULE)
    gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --source-dir=<source-dir>
    // xml files have changed
    mkdir html
    cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
    gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html

Il s'agit d'examiner les fichiers `Makefile.am` et `gtk-doc.mak` pour y trouver les options supplémentaires nécessaires.

### Intégration avec des systèmes de gestion de versions

As a rule of thumb, it's the files you edit which should go under version control. For typical projects it's these files: `<package>.types`, `<package>-docs.xml` (in the past .sgml), `<package>-sections.txt`, `Makefile.am`.

Files in the `xml/` and `html/` directories should not go under version control. Neither should any of the `.stamp` files.

## Documentation du code

GTK-Doc utilise les commentaires du code source, avec une syntaxe spéciale pour la documentation du code. En outre, il récupère des informations sur la structure de votre projet à partir d'autres sources. La section suivante vous donne toutes les informations concernant la syntaxe des commentaires.

The GTK-Doc scanner can handle the majority of C headers fine. In the case of receiving warnings from the scanner that look like a special case, one can hint GTK-Doc to skip over them.

GTK-Doc comment block

    #ifndef __GTK_DOC_IGNORE__
    /* unparseable code here */
    #endif

Limitations

Note, that GTK-Doc's supports `#ifndef(__GTK_DOC_IGNORE__)` but not `#if !defined(__GTK_DOC_IGNORE__)` or other combinations.

### Commentaires de documentation

Un commentaire multi-ligne qui commence avec un symbole « * » supplémentaire indique un bloc de documentation qui sera traité par les outils GTK-Doc.

Bloc de commentaire GTK-Doc

    /**
     * identifier:
     * documentation ...
     */

L'« identifier » (identifiant) est une ligne contenant le nom de l'élément avec lequel le commentaire est lié. La syntaxe diffère légèrement en fonction de l'élément. (À FAIRE : ajouter un tableau montrant les identifiants)

The 'documentation' block is also different for each symbol type. Symbol types that get parameters such as functions or macros have the parameter description first followed by a blank line (just a '*'). Afterwards follows the detailed description. All lines (outside program listings and CDATA sections) just containing a ' *' (blank-asterisk) are converted to paragraph breaks. If you don't want a paragraph break, change that into ' * ' (blank-asterisk-blank-blank). This is useful in preformatted text (code listings).

En documentant le code, deux aspects doivent être abordés :

- Ce que c'est : le nom d'une classe ou d'une fonction peut parfois être trompeur pour les personnes habituées à d'autres environnements.

- Ce qu'il fait : indiquer les usages courants. À mettre en relation avec les autres API.

L'un des avantages de l'hypertexte par rapport au texte simple, c'est la possibilité d'avoir des liens dans les documents. Écrire correctement le balisage d'un lien peut être fastidieux. GTK-Doc fournit plusieurs raccourcis utiles pour vous aider.

- Utilisez fonction() pour vous référer à des fonctions ou des macros qui prennent des arguments.

- Utilisez @paramètre pour vous référer aux paramètres. Utilisez-le aussi pour les paramètres d'autres fonctions, en relation avec celle décrite.

- Utilisez %constante pour vous référer à une constante, par ex. : %MA_CONSTANTE.

- Utilisez #symbole pour vous référer à d'autres types de symbole. Par exemple des structures, énumérations ou macros qui ne prennent pas d'arguments.

- Use #Object::signal to refer to a GObject signal.

- Use #Object:property to refer to a GObject property.

- Use #Struct.field to refer to a field inside a structure and #GObjectClass.foo_bar() to refer to a vmethod.

Si vous avez besoin d'utiliser les caractères spéciaux « '<', '> », « () », « @ », « % » ou « # » dans votre documentation sans que GTK-Doc ne les interprète, vous pouvez utiliser les entités XML « &lt; », « &gt; », « &lpar; », « &rpar; », « &commat; », « &percnt; », « &num; » ou les échapper en les précédant d'un antislash « \ ».

DocBook can do more than just links. One can also have lists, examples, headings, and images. As of version 1.20, the preferred way is to use a subset of the basic text formatting syntax called Markdown. On older GTK-Doc versions any documentation that includes Markdown will be rendered as is. For example, list items will appear as lines starting with a dash.

While markdown is now preferred one can mix both. One limitation here is that one can use docbook xml within markdown, but markdown within docbook xml is not supported.

In older GTK-Doc releases, if you need support for additional formatting, you would need to enable the usage of docbook XML tags inside doc-comments by putting `--xml-mode` (or `--sgml-mode`) in the variable MKDB_OPTIONS inside `Makefile.am`.

GTK-Doc comment block using Markdown

    /**
     * identifier:
     *
     * documentation paragraph ...
     *
     * # Sub Heading #
     *
     * ## Second Sub Heading
     *
     * # Sub Heading With a Link Anchor # {#heading-two}
     *
     * more documentation:
     *
     * - list item 1
     *
     *   Paragraph inside a list item.
     *
     * - list item 2
     *
     * 1. numbered list item
     *
     * 2. another numbered list item
     *
     * Another paragraph. [A Link to the GNOME Website](http://www.gnome.org/)
     *
     * ![an inline image](plot-result.png)
     *
     * [A link to the heading anchor above][heading-two]
     *
     * A C-language example:
     * |[<!-- language="C" -->
     * GtkWidget *label = gtk_label_new ("Gorgeous!");
     * ]|
     */

More examples of what markdown tags are supported can be found in the GTK Documentation Markdown Syntax Reference.

As already mentioned earlier GTK-Doc is for documenting public API. Thus one cannot write documentation for static symbols. Nevertheless it is good to comment those symbols too. This helps other developers to understand your code. Therefore we recommend to comment these using normal comments (without the 2nd '*' in the first line). If later the function needs to be made public, all one needs to do is to add another '*' in the comment block and insert the symbol name at the right place inside the sections file.

### Documentation des sections

Chaque section de la documentation contient des informations sur une classe ou un module. Pour introduire le composant, il est possible d'écrire un bloc de section. La description courte est également utilisée dans la table des matières. Tous les @champs sont facultatifs.

Bloc de commentaires de section

    /**
     * SECTION:meepapp
     * @short_description: the application class
     * @title: Meep application
     * @section_id:
     * @see_also: #MeepSettings
     * @stability: Stable
     * @include: meep/app.h
     * @image: application.png
     *
     * The application class handles ...
     */

SECTION:<nom>

  The name links the section documentation to the respective part in the `<package>-sections.txt` file. The name given here should match the <FILE> tag in the `<package>-sections.txt` file.

@short_description

  Une description de la section en une seule ligne, elle apparaîtra derrière les liens dans la table des matières et au début de la page de la section.

@title

  Par défaut, la section titre est celle de la déclaration SECTION: <nom>. Elle peut être modifiée grâce au champ @title.

@section_id

  Remplace l'utilisation du titre comme identificateur de section. Pour GObjects, <title> est utilisé à la place de section_id et pour les autres sections, c'est <MODULE>-<title>.

@see_also

  Une liste de symboles qui ont un lien avec cette section.

@stability

  An informal description of the stability level this API has. We recommend the use of one of these terms:

  - Stable - The intention of a Stable interface is to enable arbitrary third parties to develop applications to these interfaces, release them, and have confidence that they will run on all minor releases of the product (after the one in which the interface was introduced, and within the same major release). Even at a major release, incompatible changes are expected to be rare, and to have strong justifications.

  - Unstable - Unstable interfaces are experimental or transitional. They are typically used to give outside developers early access to new or rapidly changing technology, or to provide an interim solution to a problem where a more general solution is anticipated. No claims are made about either source or binary compatibility from one minor release to the next.

  - Private - An interface that can be used within the GNOME stack itself, but that is not documented for end-users. Such functions should only be used in specified and documented ways.

  - Internal - An interface that is internal to a module and does not require end-user documentation. Functions that are undocumented are assumed to be Internal.

@include

  Les fichiers `#include` à afficher dans le résumé de la section (liste d'éléments séparés par des virgules), elle outrepasse la valeur globale du fichier de section ou de la ligne de commande. Cet élément est facultatif.

@image

  L'image à afficher en haut de la page de référence pour cette section. C'est très souvent une espèce de diagramme pour illustrer l'apparence visuelle d'une classe ou un diagramme de ses relations avec d'autres classes. Cet élément est facultatif.

Pour éviter des recompilations inutiles après des modifications de la documentation, placez la documentation de section dans les fichiers sources C, lorsque cela est possible.

### Documentation des symboles

Chaque symbole (fonction, macro, structure, énumération, signal et propriété) est documenté dans un bloc séparé. Il est mieux de placer le bloc près de la définition de son symbole pour faciliter sa synchronisation. Par conséquent, les fonctions sont habituellement documentées dans les fichiers sources C et les macros et les structures et les énumérations le sont dans le fichier d'en-tête.

#### Étiquettes générales

Vous pouvez ajouter des informations de version à tous les éléments de documentation pour indiquer quand l'API a été introduite ou quand elle est devenue obsolète.

Étiquettes de version

« Since »:

  Texte indiquant depuis quelle version du code cette API est disponible.

« Deprecated » :

  Texte indiquant que cette fonction ne doit plus être utilisée. La description doit rediriger le lecteur vers la nouvelle API.

You can also add stability information to all documentation elements to indicate whether API stability is guaranteed for them for all future minor releases of the project.

The default stability level for all documentation elements can be set by passing the `--default-stability` argument to gtkdoc-mkdb with one of the values below.

Stability Tags

Stability: Stable

  Mark the element as stable. This is for public APIs which are guaranteed to remain stable for all future minor releases of the project.

Stability: Unstable

  Mark the element as unstable. This is for public APIs which are released as a preview before being stabilised.

Stability: Private

  Mark the element as private. This is for interfaces which can be used by tightly coupled modules, but not by arbitrary third parties.

Étiquettes générales

    /**
     * foo_get_bar:
     * @foo: some foo
     *
     * Retrieves @foo's bar.
     *
     * Returns: @foo's bar
     *
     * Since: 2.6
     * Deprecated: 2.12: Use foo_baz_get_bar() instead.
     */
    Bar *
    foo_get_bar(Foo *foo)
    {
    ...

#### Annotations

Documentation blocks can contain annotation-tags. These tags will be rendered with tooltips describing their meaning. The tags are used by GObject Introspection to generate language bindings. A detailed list of the supported tags can be found in the GObject Introspection documentation.

Annotations

    /**
     * foo_get_bar: (annotation)
     * @foo: (annotation): some foo
     *
     * Retrieves @foo's bar.
     *
     * Returns: (annotation): @foo's bar
     */
    ...
    /**
     * foo_set_bar_using_the_frobnicator: (annotation) (another annotation)
     *                                    (and another annotation)
     * @foo: (annotation) (another annotation): some foo
     *
     * Sets bar on @foo.
     */

#### Bloc de commentaires pour les fonctions

N'oubliez pas :

- d'indiquer si les objets, listes, chaînes, etc. retournés doivent être freed/unfreed/released,

- d'indiquer si les paramètres peuvent être NULL et ce qui se passe dans ce cas.

- Mentionner les pré-conditions et post-conditions intéressantes si nécessaire.

GTK-Doc considère que tous les symboles (macros, fonctions) commençant par « _ » sont privés. Ils sont traités comme des fonctions statiques.

Bloc de commentaires pour les fonctions

    /**
     * function_name:
     * @par1:  description of parameter 1. These can extend over more than
     * one line.
     * @par2:  description of parameter 2
     * @...: a %NULL-terminated list of bars
     *
     * The function description goes here. You can use @par1 to refer to parameters
     * so that they are highlighted in the output. You can also use %constant
     * for constants, function_name2() for functions and #GtkWidget for links to
     * other declarations (which may be documented elsewhere).
     *
     * Returns: an integer.
     *
     * Since: 2.2
     * Deprecated: 2.18: Use other_function() instead.
     */

Étiquettes de fonction

« Returns » :

  Paragraphe décrivant le résultat retourné.

@...:

  Au cas où la fonction possède des arguments variables, vous devriez utiliser cette étiquette (@Varargs : peut également être utilisé pour des raisons historiques).

#### Bloc de commentaires pour les propriétés

Bloc de commentaires pour les propriétés

    /**
     * SomeWidget:some-property:
     *
     * Here you can document a property.
     */
    g_object_class_install_property (object_class, PROP_SOME_PROPERTY, ...);

#### Bloc de commentaires pour les signaux

N'oubliez pas :

- Documenter lorsque le signal est émis et s'il est émis avant ou après d'autres signaux,

- Documenter ce qu'une application pourrait faire dans le gestionnaire du signal.

Bloc de commentaires pour les signaux

    /**
     * FooWidget::foobarized:
     * @widget: the widget that received the signal
     * @foo: some foo
     * @bar: some bar
     *
     * The ::foobarized signal is emitted each time someone tries to foobarize @widget.
     */
    foo_signals[FOOBARIZED] =
      g_signal_new ("foobarized",
                    ...

#### Bloc de commentaire pour les structures

Bloc de commentaire pour les structures

    /**
     * FooWidget:
     * @bar: some #gboolean
     *
     * This is the best widget, ever.
     */
    typedef struct _FooWidget {
      GtkWidget parent_instance;

      gboolean bar;
    } FooWidget;

Utilisez `/*< private >*/` avant les champs de structures privées que vous voulez cacher. Utilisez `/*< public >*/` dans le cas contraire.

If the first field is "g_iface", "parent_instance" or "parent_class" it will be considered private automatically and doesn't need to be mentioned in the comment block.

Les blocs de commentaire pour les structures peuvent aussi être utilisés avec GObjects et GObjectClasses. Il est normalement recommandé d'ajouter un bloc de commentaire pour une classe, si elle contient des vmethods (car c'est la manière de les documenter). Pour GObject, il est possible d'utiliser la documentation de section correspondante ; la présence d'un bloc séparé pour la structure de l'instance serait utile si l'instance possède des champs publics. Le désavantage ici étant que cela crée deux entrées d'index pour le même nom (la structure et la section).

#### Bloc de commentaire pour les énumérations

Bloc de commentaire pour les énumérations

    /**
     * Something:
     * @SOMETHING_FOO: something foo
     * @SOMETHING_BAR: something bar
     *
     * Enum values used for the thing, to specify the thing.
     */
    typedef enum {
      SOMETHING_FOO,
      SOMETHING_BAR,
      /*< private >*/
      SOMETHING_COUNT
    } Something;

Utilisez `/*< private >*/` avant les valeurs d'énumérations privées que vous voulez cacher. Utilisez `/*< public >*/` dans le cas contraire.

### Inline program documentation

You can document programs and their commandline interface using inline documentation.

Tags

PROGRAM

  Defines the start of a program documentation.

@short_description:

  Defines a short description of the program. (Optional)

@synopsis:

  Defines the arguments, or list of arguments that the program can take. (Optional)

@see_also:

  See Also manual page section. (Optional)

@arg:

  Argument(s) passed to the program and their description. (Optional)

Description:

  A longer description of the program.

« Returns » :

  Specify what value(s) the program returns. (Optional)

#### Example of program documentation.

Bloc de documentation programme

    /**
     * PROGRAM:test-program
     * @short_description: A test program
     * @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE*
     * @see_also: test(1)
     * @--arg1 *arg*: set arg1 to *arg*
     * @--arg2 *arg*: set arg2 to *arg*
     * @-v, --version: Print the version number
     * @-h, --help: Print the help message
     *
     * Long description of program.
     *
     * Returns: Zero on success, non-zero on failure
     */
    int main(int argc, char *argv[])
    {
    	return 0;
    }

### Balises DocBook utiles

Voici quelques balises DocBook très utiles pendant la conception de la documentation d'un code.

Pour créer un lien vers une autre section dans la documentation GTK :

    <link linkend="glib-Hash-Tables">Hash Tables</link>

l'élément « linkend » est l'identifiant SGML/XML de l'élément le plus haut sur la page vers laquelle vous voulez pointer. Pour la plupart des pages, c'est en général la partie (« gtk », « gdk », « glib ») suivi du titre de la page (« Hash Tables »). Pour les éléments graphiques, c'est simplement le nom de la classe. Les espaces et les caractères de soulignement sont convertis en « - » pour être conforme au SGML/XML.

Pour faire référence à une fonction externe comme, par exemple, à une fonction C standard :

    <function>...</function>

To include example code:

    <example>
      <title>Using a GHashTable.</title>
      <programlisting language="C">
          ...
      </programlisting>
    </example>

or possibly this, for very short code fragments which don't need a title:

    <informalexample>
      <programlisting language="C">
      ...
      </programlisting>
    </informalexample>

In both cases, the language attribute is optional and is used as a hint to the syntax highlighting engine (pygments for html output). For the latter GTK-Doc also supports an abbreviation:

    |[<!-- language="C" -->
      ...
    ]|

Pour ajouter une liste à puces :

    <itemizedlist>
      <listitem>
        <para>
          ...
        </para>
      </listitem>
      <listitem>
        <para>
          ...
        </para>
      </listitem>
    </itemizedlist>

Pour ajouter une note de bas de page :

    <note>
      <para>
        Make sure you free the data after use.
      </para>
    </note>

Pour se référer à un type :

    <type>unsigned char</type>

Pour se référer à une structure externe (non décrite dans la documentation GTK) :

    <structname>XFontStruct</structname>

Pour se référer à un champ d'une structure :

    <structfield>len</structfield>

Pour se référer au nom d'une classe, il est possible d'utiliser :

    <classname>GtkWidget</classname>

mais vous utiliserez probablement #GtkWidget à la place (pour créer automatiquement un lien vers la page GtkWidget - consultez les raccourcis).

Pour mettre en évidence un texte :

    <emphasis>This is important</emphasis>

Pour les noms de fichiers :

    <filename>/home/user/documents</filename>

Pour se référer à des touches :

    <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>

## Remplissage des fichiers supplémentaires

Il y a plusieurs fichiers supplémentaires, qui ont besoin d'être maintenus en parallèle aux commentaires dans le code source : `<package>.types`, `<package>-docs.xml` (anciennement .sgml), `<package>-sections.txt`.

### Édition des fichiers types

If your library or application includes GObjects, you want their signals, arguments/parameters and position in the hierarchy to be shown in the documentation. All you need to do, is to list the `xxx_get_type` functions together with their include inside the `<package>.types` file.

Example <package>.types file

    #include <gtk/gtk.h>

    gtk_accel_label_get_type
    gtk_adjustment_get_type
    gtk_alignment_get_type
    gtk_arrow_get_type

Depuis GTK-Doc 1.8, gtkdoc-scan peut générer cette liste pour vous. Ajoutez simplement l'option « --rebuild-types » à SCAN_OPTIONS dans le fichier `Makefile.am`. Si vous utilisez cette approche vous ne devriez pas distribuer le fichier « types », ni l'avoir dans le système de gestion de versions.

### Édition du document maître

GTK-Doc génère de la documentation au format SGML/XML DocBook. Lors du traitement des commentaires dans les fichiers sources, les outils GTK-Doc génèrent une page de documentation par classe ou par module dans un fichier séparé. Le document maître les inclut et les place dans l'ordre.

While GTK-Doc creates a template master document for you, later runs will not touch it again. This means that one can freely structure the documentation. That includes grouping pages and adding extra pages. GTK-Doc has now a test suite, where also the master-document is recreated from scratch. Its a good idea to look at this from time to time to see if there are some new goodies introduced there.

Ne créez pas de tutoriels comme documents supplémentaires. Écrivez juste des chapitres supplémentaires. L'avantage d'inclure le tutoriel de votre bibliothèque directement dans la documentation de l'API est qu'il est facile d'y ajouter des liens qui pointent vers la documentation des symboles. De plus, il y aura plus de chance que votre tutoriel soit mis à jour en même temps que la bibliothèque.

Alors, quelles sont les choses à modifier dans le document maître ? Pour commencer, très peu de choses. Il n'y a quelques paramètres substituables (texte entre crochets) que vous devrez prendre en charge.

En-tête du document maître

    <bookinfo>
      <title>MODULENAME Reference Manual</title>
      <releaseinfo>
        for MODULENAME [VERSION]
        The latest version of this documentation can be found on-line at
        <ulink role="online-location" url="http://[SERVER]/MODULENAME/index.html">http://[SERVER]/MODULENAME/</ulink>.
      </releaseinfo>
    </bookinfo>

    <chapter>
      <title>[Insert title here]</title>

In addition a few option elements are created in commented form. You can review these and enable them as you like.

Partie optionnelle dans le document maître

      <!-- enable this when you use gobject introspection annotations
      <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
      -->

Finally you need to add new section whenever you introduce one. The gtkdoc-check tool will remind you of newly generated xml files that are not yet included into the doc.

Including generated sections

      <chapter>
        <title>my library</title>
          <xi:include href="xml/object.xml"/>
          ...

### Édition du fichier section

Le fichier section est utilisé pour organiser la documentation générée par GTK-Doc. C'est ici qu'il faut indiquer quels symboles sont attachés à quels modules ou classes et contrôler la visibilité (« public » ou « private »).

The section file is a plain text file with tags delimiting sections. Blank lines are ignored and lines starting with a '#' are treated as comment lines.

While the tags make the file look like xml, it is not. Please do not close tags like <SUBSECTION>.

Including generated sections

    <INCLUDE>libmeep/meep.h</INCLUDE>

    <SECTION>
    <FILE>meepapp</FILE>
    <TITLE>MeepApp</TITLE>
    MeepApp
    <SUBSECTION Standard>
    MEEP_APP
    ...
    MeepAppClass
    meep_app_get_type
    </SECTION>

The <FILE> ... </FILE> tag is used to specify the file name, without any suffix. For example, using '<FILE>gnome-config</FILE>' will result in the section declarations being output in the template file `tmpl/gnome-config.sgml`, which will be converted into the DocBook XML file `xml/gnome-config.sgml` or the DocBook XML file `xml/gnome-config.xml`. (The name of the HTML file is based on the module name and the section title, or for GObjects it is based on the GObjects class name converted to lower case).

La balise <TITLE> ... </TITLE> est utilisée pour indiquer le titre de la section. C'est utile seulement avant la création initiale des prototypes, car ensuite le titre défini dans le prototype est prioritaire. Elle est également obsolète si des commentaires de SECTION sont utilisés dans les fichiers sources.

You can group items in the section by using the <SUBSECTION> tag. Currently it outputs a blank line between subsections in the synopsis section. You can also use <SUBSECTION Standard> for standard GObject declarations (e.g. the functions like g_object_get_type and macros like G_OBJECT(), G_IS_OBJECT() etc.). Currently these are left out of the documentation. You can also use <SUBSECTION Private> for private declarations which will not be output (it is a handy way to avoid warning messages about unused declarations). If your library contains private types which you don't want to appear in the object hierarchy and the list of implemented or required interfaces, add them to a Private subsection. Whether you would place GObject and GObjectClass like structs in public or Standard section depends if they have public entries (variables, vmethods).

Vous pouvez utiliser les balises <INCLUDE> ... </INCLUDE> pour indiquer les fichiers #include qui sont affichés dans les sections résumé. Elles contiennent une liste de fichiers #include, séparés par des virgules, sans les chevrons. Si vous les placez en dehors d'une section, elles s'appliquent à toutes les sections jusqu'à la fin du fichier. Si vous les placez dans une section, elles s'appliquent seulement à cette section.

## Contrôle du résultat

Une exécution de GTK-Doc produit des fichiers de compte-rendu dans le répertoire de documentation. Ces fichiers sont nommés : `<package>-undocumented.txt`, `<package>-undeclared.txt` et `<package>-unused.txt`. Tous ces fichiers texte peuvent être lus et post-traités facilement.

Le fichier `<package>-undocumented.txt` commence avec un résumé du sujet couvert par la documentation. Suivent deux sections séparées par des lignes blanches. La première section liste les symboles non documentés ou incomplets. La seconde section fait de même pour les documentations de sections. Les éléments incomplets sont ceux qui possèdent une documentation mais auxquels, par exemple, un paramètre a été ajouté.

Le fichier `<package>-undeclared.txt` liste les symboles contenus dans le fichier `<package>-sections.txt` mais non trouvés dans les fichiers sources. Vérifiez s'ils n'ont pas été supprimés ou mal orthographiés.

Le fichier `<package>-unused.txt` liste les noms des symboles pour lesquels l'analyseur GTK-Doc a trouvé de la documentation mais ne sait pas où la placer. Cela signifie que le symbole n'a pas encore été ajouté au fichier `<package>-sections.txt`.

Activez ou ajoutez la ligne `TESTS=($GTKDOC_CHECK)` dans le fichier Makefile.am. Si la version installée de GTK-Doc est supérieure à 1.9, des contrôles de validité seront lancés pendant l'exécution de `make check`.

One can also look at the files produced by the source code scanner: `<package>-decl-list.txt` and `<package>-decl.txt`. The first one can be compared with the section file if that is manually maintained. The second lists all declarations from the headers. If a symbol is missing one could check if this file contains it.

If the project is GObject based, one can also look into the files produced by the object scanner: `<package>.args.txt`, `<package>.hierarchy.txt`, `<package>.interfaces.txt`, `<package>.prerequisites.txt` and `<package>.signals.txt`. If there are missing symbols in any of those, one can ask GTK-Doc to keep the intermediate scanner file for further analysis, by running it as `GTK_DOC_KEEP_INTERMEDIATE=1 make`.

## Modernisation de la documentation

GTK-Doc has been around for quite some time. In this section we list new features together with the version since when it is available.

### Manuel de GTK-Doc 1.9

When using xml instead of sgml, one can actually name the master document `<package>-docs.xml`.

This version supports `SCAN_OPTIONS=--rebuild-sections` in `Makefile.am`. When this is enabled, the `<package>-sections.txt` is autogenerated and can be removed from the vcs. This only works nicely for projects that have a very regular structure (e.g. each .{c,h} pair will create new section). If one organize a project close to that updating a manually maintained section file can be as simple as running `meld <package>-decl-list.txt <package>-sections.txt`.

Version 1.8 already introduced the syntax for documenting sections in the sources instead of the separate files under `tmpl`. This version adds options to switch the whole doc module to not use the extra tmpl build step at all, by using `--flavour no-tmpl` in `configure.ac`. If you don't have a `tmpl` checked into your source control system and haven't yet switched, just add the flag to `configure.ac` and you are done.

### Manuel de GTK-Doc 1.10

This version supports `SCAN_OPTIONS=--rebuild-types` in `Makefile.am`. When this is enabled, the `<package>.types` is autogenerated and can be removed from the vcs. When using this feature it is important to also setup the `IGNORE_HFILES` in `Makefile.am` for code that is build conditionally.

### Manuel de GTK-Doc 1.16

This version includes a new tool called gtkdoc-check. This tool can run a set of sanity checks on your documentation. It is enabled by adding these lines to the end of `Makefile.am`.

Enable gtkdoc-check

    if ENABLE_GTK_DOC
    TESTS_ENVIRONMENT = \
      DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
      SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
    TESTS = $(GTKDOC_CHECK)
    endif

### Manuel de GTK-Doc 1.20

Version 1.18 brought some initial markdown support. Using markdown in doc comments is less intrusive than writing docbook xml. This version improves a lot on this and add a lot more styles. The section that explains the comment syntax has all the details.

### Manuel de GTK-Doc 1.25

The makefiles shipped with this version generate an entity file at `xml/gtkdocentities.ent`, containing entities for e.g. package_name and package_version. You can use this e.g. in the main xml file to avoid hardcoding the version number. Below is an example that shows how the entity file is included in the master template and how the entities are used. The entities can also be used in all generated files, GTK-Doc will use the same xml header in generated xml files.

Use pre-generated entities

    <?xml version="1.0"?>
    <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
    [
      <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
      <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
      %gtkdocentities;
    ]>
    <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
      <bookinfo>
        <title>&package_name; Reference Manual</title>
        <releaseinfo>
          for &package_string;.
          The latest version of this documentation can be found on-line at
          <ulink role="online-location" url="http://[SERVER]/&package_name;/index.html">http://[SERVER]/&package_name;/</ulink>.
        </releaseinfo>
      </bookinfo>

## Documentation d'autres interfaces

Nous avons jusqu'ici utilisé GTK-Doc pour documenter les API du code. Les sections qui suivent contiennent des suggestions sur la manière d'utiliser les outils pour documenter aussi d'autres interfaces.

### Options de ligne de commande et pages de manuel

Comme il est possible de générer aussi des pages de manuel à partir d'une « refentry » DocBook, il semble donc intéressant de l'utiliser dans ce but. Ainsi, l'interface fait partie de la référence et l'on obtient en cadeau la page de manuel.

#### Documentation de l'outil

Créez un fichier « refentry » par outil. En suivant notre exemple, nous l'appellerons `meep/docs/reference/meeper/meep.xml`. Pour connaître les balises XML pouvant être utilisées, on peut observer le fichier généré dans le sous-répertoire xml ou des exemples comme dans glib.

#### Ajout de contrôles « configure » supplémentaires

Contrôles « configure » supplémentaires

    AC_ARG_ENABLE(man,
                  [AC_HELP_STRING([--enable-man],
                                  [regenerate man pages from Docbook [default=no]])],enable_man=yes,
                  enable_man=no)

    AC_PATH_PROG([XSLTPROC], [xsltproc])
    AM_CONDITIONAL(ENABLE_MAN, test x$enable_man != xno)

#### Ajout de règles « makefile » supplémentaires

Contrôles « configure » supplémentaires

    man_MANS = \
           meeper.1

    if ENABLE_GTK_DOC
    if ENABLE_MAN

    %.1 : %.xml
            @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<

    endif
    endif

    BUILT_EXTRA_DIST = $(man_MANS)
    EXTRA_DIST += meep.xml

### Interfaces DBus

(À_CORRIGER : http://hal.freedesktop.org/docs/DeviceKit/DeviceKit.html, http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)

## Foire aux questions

Question Réponse
- Pas de hiérarchie de classe. Les fonctions objet `xxx_get_type()` n'ont pas été saisies dans le fichier `<module>.types`.
- Toujours pas de hiérarchie de classe. Mauvais nom ou nom absent dans le fichier `<module>-sections.txt` (consultez une explication).
- Zut, je n'ai toujours pas de hiérarchie de classe. Est-ce que le nom de l'objet (nom de la structure de l'instance, par ex. GtkWidget) fait parti de la section « normal » (ne pas le mettre dans les sous-sections « Standard » ou « Private »).
- Pas d'index des symboles. Est-ce que `<module>-docs.{xml,sgml}` contient un index qui « xi:includes » l'index généré ?
- Les symboles ne sont pas liés à leur section de documentation. Est-ce que doc-comment utilise le markup correct (ajout d'un #, % ou ()) ? Contrôlez si gtkdoc-fixxref affiche des avertissements à propos de xrefs non résolus.
- Une nouvelle classe n'apparaît pas dans les documents. Est-ce que la nouvelle page est xi:included à partir de `<module>-docs.{xml,sgml}`.
- Un nouveau symbole n'apparaît pas dans les documents. Est-ce que le doc-comment est correctement formaté. Vérifiez qu'il n'y a pas d'erreur de frappe au début du commentaire. Vérifiez que gtkdoc-fixxref ne vous indique pas de xrefs non résolus. Vérifiez que le symbole est correctement listé dans une section publique de `<module>-sections.txt`.
- Un type est absent dans la hiérarchie de classe. If the type is listed in `<package>.hierarchy` but not in `xml/tree_index.sgml` then double check that the type is correctly placed in the `<package>-sections.txt`. If the type instance (e.g. GtkWidget) is not listed or incidentally marked private it will not be shown.
- J'obtiens des liens foldoc pour toutes les annotations gobject. Vérifiez que `xml/annotation-glossary.xml` est xi:included à partir de `<module>-docs.{xml,sgml}`.
- Un paramètre est décrit dans le bloc de commentaires dans le code source mais il n'existe pas. Vérifiez si le prototype dans le fichier d'en-tête possède des noms de paramètres différents de ceux du fichier source.
- « ID » multiples pour le linkend: XYZ contraint Le symbole XYZ apparaît en double dans le fichier `<package>-sections.txt`.
- Élément typename dans l'espace de nom '' rencontré dans para mais aucun prototype ne correspond.

## Outils liés à gtk-doc

GtkDocPlugin - un greffon d'intégration à Trac GTK-Doc, qui ajoute la documentation d'API à un site Trac et s'intègre à la recherche Trac.

Gtkdoc-depscan - a tool (part of gtk-doc) to check used API against since tags in the API to determine the minimum required version.

Version 1.1, mars 2000
2000 Free Software Foundation, Inc.

    Free Software Foundation, Inc. 51 Franklin Street,
            Suite 330, Boston, MA
            02110-1301  USA

Chacun est libre de copier et de distribuer des copies conformes de cette Licence, mais nul n'est autorisé à la modifier.

## Licence de Documentation Libre GNU

### 0. Préambule

L'objet de cette Licence est de rendre tout manuel, livre ou autre document écrit libre au sens de la liberté d'utilisation, à savoir : assurer à chacun la liberté effective de le copier ou de le redistribuer, avec ou sans modifications, commercialement ou non. En outre, cette Licence garantit à l'auteur et à l'éditeur la reconnaissance de leur travail, sans qu'ils soient pour autant considérés comme responsables des modifications réalisées par des tiers.

Cette Licence est une sorte de copyleft, ce qui signifie que les travaux dérivés du document d'origine sont eux-mêmes « libres » selon les mêmes termes. Elle complète la Licence Publique Générale GNU, qui est également une Licence copyleft, conçue pour les logiciels libres.

Nous avons conçu cette Licence pour la documentation des logiciels libres, car les logiciels libres ont besoin d'une documentation elle-même libre : un logiciel libre doit être accompagné d'un manuel garantissant les mêmes libertés que celles accordées par le logiciel lui-même. Mais cette Licence n'est pas limitée aux seuls manuels des logiciels ; elle peut être utilisée pour tous les documents écrits, sans distinction particulière relative au sujet traité ou au mode de publication. Nous recommandons l'usage de cette Licence principalement pour les travaux destinés à des fins d'enseignement ou devant servir de documents de référence.

### 1. APPLICABILITÉ ET DÉFINITIONS

Cette Licence couvre tout manuel ou tout autre travail écrit contenant une notice de copyright autorisant la redistribution selon les termes de cette Licence. Le mot Document se réfère ci-après à un tel manuel ou travail. Toute personne en est par définition concessionnaire et est référencée ci-après par le terme Vous.

Une Version modifiée du Document désigne tout travail en contenant la totalité ou seulement une portion de celui-ci, copiée mot pour mot, modifiée et/ou traduite dans une autre langue.

Une Section secondaire désigne une annexe au Document, ou toute information indiquant les rapports entre l'auteur ou l'éditeur et le sujet (ou tout autre sujet connexe) du Document, sans toutefois être en rapport direct avec le sujet lui-même (par exemple, si le Document est un manuel de mathématiques, une Section secondaire ne traitera d'aucune notion mathématique). Cette section peut contenir des informations relatives à l'historique du Document, des sources documentaires, des dispositions légales, commerciales, philosophiques, ou des positions éthiques ou politiques susceptibles de concerner le sujet traité.

Les Sections inaltérables sont des sections secondaires considérées comme ne pouvant être modifiées et citées comme telles dans la notice légale qui place le Document sous cette Licence.

Les Textes de couverture sont les textes courts situés sur les pages de couverture avant et arrière du Document, et cités comme tels dans la mention légale de ce Document.

Le terme Copie transparente désigne une version numérique du Document représentée dans un format dont les spécifications sont publiquement disponibles et dont le contenu peut être visualisé et édité directement et immédiatement par un éditeur de texte quelconque, ou (pour les images composées de pixels) par un programme de traitement d'images quelconque, ou (pour les dessins) par un éditeur de dessins courant. Ce format doit pouvoir être accepté directement ou être convertible facilement dans des formats utilisables directement par des logiciels de formatage de texte. Une copie publiée dans un quelconque format numérique ouvert mais dont la structure a été conçue dans le but exprès de prévenir les modifications ultérieures du Document ou dans le but d'en décourager les lecteurs n'est pas considérée comme une Copie Transparente. Une copie qui n'est pas Transparente est considérée, par opposition, comme Opaque.

Le format de fichier texte codé en ASCII générique et n'utilisant pas de balises, les formats de fichiers Texinfo ou LaTeX, les formats de fichiers SGML ou XML utilisant une DTD publiquement accessible, ainsi que les formats de fichiers HTML simple et standard, écrits de telle sorte qu'ils sont modifiables sans outil spécifique, sont des exemples de formats acceptables pour la réalisation de Copies Transparentes. Les formats suivants sont opaques : PostScript, PDF, formats de fichiers propriétaires qui ne peuvent être visualisés ou édités que par des traitements de textes propriétaires, SGML et XML utilisant des DTD et/ou des outils de formatage qui ne sont pas disponibles publiquement, et du code HTML généré par une machine à l'aide d'un traitement de texte quelconque et dans le seul but de la génération d'un format de sortie.

La Page de titre désigne, pour les ouvrages imprimés, la page de titre elle-même, ainsi que les pages supplémentaires nécessaires pour fournir clairement les informations dont cette Licence impose la présence sur la page de titre. Pour les travaux n'ayant pas de Page de titre comme décrit ci-dessus, la Page de titre désigne le texte qui s'apparente le plus au titre du document et situé avant le texte principal.

### 2. COPIES CONFORMES

Vous pouvez copier et distribuer le Document sur tout type de support, commercialement ou non, à condition que cette Licence, la notice de copyright et la notice de la Licence indiquant que cette Licence s'applique à ce Document soient reproduits dans toutes les copies, et que vous n'y ajoutiez aucune condition restrictive supplémentaire. Vous ne pouvez pas utiliser un quelconque moyen technique visant à empêcher ou à contrôler la lecture ou la reproduction ultérieure des copies que vous avez créées ou distribuées. Toutefois, vous pouvez solliciter une rétribution en échange des copies. Si vous distribuez une grande quantité de copies, référez-vous aux dispositions de la section 3.

Vous pouvez également prêter des copies, sous les mêmes conditions que celles suscitées, et vous pouvez afficher publiquement des copies de ce Document.

### 3. COPIES EN NOMBRE

Si vous publiez des copies imprimées de ce Document à plus de 100 exemplaires et que la Licence du Document indique la présence de Textes de couverture, vous devez fournir une couverture pour chaque copie, qui présente les Textes de couverture des première et dernière pages de couverture du Document. Les première et dernière pages de couverture doivent également vous identifier clairement et sans ambiguïté comme étant l'éditeur de ces copies. La première page de couverture doit comporter le titre du Document en mots d'importance et de visibilité égales. Vous pouvez ajouter des informations complémentaires sur les pages de couverture. Les copies du Document dont seule la couverture a été modifiée peuvent être considérées comme des copies conformes, à condition que le titre du Document soit préservé et que les conditions indiquées précédemment soient respectées.

Si les textes devant se trouver sur la couverture sont trop importants pour y tenir de manière claire, vous pouvez ne placer que les premiers sur la première page et placer les suivants sur les pages consécutives.

Si vous publiez plus de 100 Copies opaques du Document, vous devez soit fournir une Copie transparente pour chaque Copie opaque, soit préciser ou fournir avec chaque Copie opaque une adresse réseau publiquement accessible d'une Copie transparente et complète du Document, sans aucun ajout ou modification, et à laquelle tout le monde peut accéder en téléchargement anonyme et sans frais, selon des protocoles réseau communs et standard. Si vous choisissez cette dernière option, vous devez prendre les dispositions nécessaires, dans la limite du raisonnable, afin de garantir l'accès non restrictif à la Copie transparente durant une année pleine après la diffusion publique de la dernière Copie opaque(directement ou via vos revendeurs).

Nous recommandons, mais ce n'est pas obligatoire, que vous contactiez l'auteur du Document suffisamment tôt avant toute publication d'un grand nombre de copies, afin de lui permettre de vous donner une version à jour du Document.

### 4. MODIFICATIONS

Vous pouvez copier et distribuer une Version modifiée du Document en respectant les conditions des sections 2 et 3 précédentes, à condition de placer cette Version modifiée sous la présente Licence, dans laquelle le terme « Document » doit être remplacé par les termes « Version modifiée », donnant ainsi l'autorisation de redistribuer et de modifier cette Version modifiée à quiconque en possède une copie. De plus, vous devez effectuer les actions suivantes dans la Version modifiée :

- A

  Utiliser sur la Page de titre (et sur la page de couverture éventuellement présente) un titre distinct de celui du Document d'origine et de toutes ses versions antérieures (qui, si elles existent, doivent être mentionnées dans la section Historique du Document). Vous pouvez utiliser le même titre si l'éditeur d'origine vous en a donné expressément la permission.

- B

  Mentionner sur la Page de titre en tant qu'auteurs une ou plusieurs des personnes ou entités responsables des modifications de la Version modifiée, avec au moins les cinq principaux auteurs du Document (ou tous les auteurs s'il y en a moins de cinq).

- C

  Préciser sur la Page de titre le nom de l'éditeur de la Version modifiée, en tant qu'éditeur du Document.

- D

  Préserver intégralement toutes les notices de copyright du Document.

- E

  Ajouter une notice de copyright adjacente aux autres notices pour vos propres modifications.

- F

  Inclure immédiatement après les notices de copyright une notice donnant à quiconque l'autorisation d'utiliser la Version modifiée selon les termes de cette Licence, sous la forme présentée dans l'annexe indiquée ci-dessous.

- G

  Préserver dans cette notice la liste complète des Sections inaltérables et les Textes de couverture donnés avec la notice de la Licence du Document.

- H

  Inclure une copie non modifiée de cette Licence.

- I

  Préserver la section nommée Historique et son titre, et y ajouter une nouvelle entrée décrivant le titre, l'année, les nouveaux auteurs et l'éditeur de la Version modifiée, tels que décrits sur la Page de titre, ainsi qu'un descriptif des modifications apportées depuis la précédente version. S'il n'y a pas de section nommée Historique dans le Document, créer une telle section précisant le titre, l'année, les auteurs et l'éditeur du Document tel que précisé sur la Page de titre, et ajouter une entrée décrivant la Version modifiée tel que précisé dans la phrase précédente.

- J

  Conserver l'adresse réseau éventuellement indiquée dans le Document permettant à quiconque d'accéder à une Copie transparente du Document, ainsi que les adresses réseau indiquées dans le Document pour les versions précédentes sur lesquelles le Document se base. Ces liens peuvent être placés dans la section Historique. Vous pouvez ne pas conserver les liens pour un travail datant de plus de quatre ans avant la version courante ou si l'éditeur d'origine vous en accorde la permission.

- K

  Si une section Remerciements ou une section Dédicaces sont présentes, les informations et les appréciations concernant les contributeurs et les personnes auxquelles s'adressent ces remerciements doivent être conservées, ainsi que le titre de ces sections.

- L

  Conserver sans modification les Sections inaltérables du Document, ni dans leurs textes, ni dans leurs titres. Les numéros de sections ne sont pas considérés comme faisant partie du texte des sections.

- M

  Effacer toute section intitulée Approbations. Une telle section ne peut pas être incluse dans une Version modifiée.

- N

  Ne pas renommer une section existante sous le titre Approbations ou sous un autre titre entrant en conflit avec le titre d'une Section inaltérable.

Si la Version modifiée contient de nouvelles sections préliminaires ou de nouvelles annexes considérées comme des Sections secondaires et que celles-ci ne contiennent aucun élément copié à partir du Document, vous pouvez à votre convenance en désigner une ou plusieurs comme étant des Sections inaltérables. Pour ce faire, ajoutez leurs titres dans la liste des Sections inaltérables au sein de la notice de Licence de la Version modifiée. Ces titres doivent êtres distincts des titres des autres sections.

Vous pouvez ajouter une section nommée Approbations à condition que ces approbations ne concernent que les modifications ayant donné naissance à la Version modifiée (par exemple, comptes rendus de revue du document ou acceptation du texte par une organisation le reconnaissant comme étant la définition d'un standard).

Vous pouvez ajouter un passage comprenant jusqu'à cinq mots en première page de couverture, et jusqu'à vingt-cinq mots en dernière page de couverture, à la liste des Textes de couverture de la Version modifiée. Il n'est autorisé d'ajouter qu'un seul passage en première et en dernière pages de couverture par personne ou groupe de personnes ou organisation ayant contribué à la modification du Document. Si le Document comporte déjà un passage sur la même couverture, ajouté en votre nom ou au nom de l'organisation au nom de laquelle vous agissez, vous ne pouvez pas ajouter de passage supplémentaire ; mais vous pouvez remplacer un ancien passage si vous avez expressément obtenu l'autorisation de l'éditeur de celui-ci.

Cette Licence ne vous donne pas le droit d'utiliser le nom des auteurs et des éditeurs de ce Document à des fins publicitaires ou pour prétendre à l'approbation d'une Version modifiée.

### 5. FUSION DE DOCUMENTS

Vous pouvez fusionner le Document avec d'autres documents soumis à cette Licence, suivant les spécifications de la section 4 pour les Versions modifiées, à condition d'inclure dans le document résultant toutes les Sections inaltérables des documents originaux sans modification, et de toutes les lister dans la liste des Sections inaltérables de la notice de Licence du document résultant de la fusion.

Le document résultant de la fusion n'a besoin que d'une seule copie de cette Licence, et les Sections inaltérables existant en multiples exemplaires peuvent être remplacées par une copie unique. S'il existe plusieurs Sections inaltérables portant le même nom mais de contenu différent, rendez unique le titre de chaque section en ajoutant, à la fin de celui-ci, entre parenthèses, le nom de l'auteur ou de l'éditeur d'origine, ou, à défaut, un numéro unique. Les mêmes modifications doivent être réalisées dans la liste des Sections inaltérables de la notice de Licence du document final.

Dans le document résultant de la fusion, vous devez rassembler en une seule toutes les sections Historique des documents d'origine. De même, vous devez rassembler les sections Remerciements et Dédicaces. Vous devez supprimer toutes les sections Approbations.

### 6. REGROUPEMENTS DE DOCUMENTS

Vous pouvez créer un regroupement de documents comprenant le Document et d'autres documents soumis à cette Licence, et remplacer les copies individuelles de cette Licence des différents documents par une unique copie incluse dans le regroupement de documents, à condition de respecter pour chacun de ces documents l'ensemble des règles de cette Licence concernant les copies conformes.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

### 7. AGRÉGATION AVEC DES TRAVAUX INDÉPENDANTS

La compilation du Document ou de ses dérivés avec d'autres documents ou travaux séparés et indépendants sur un support de stockage ou sur un média de distribution quelconque ne représente pas une Version modifiée du Document tant qu'aucun copyright n'est déposé pour cette compilation. Une telle compilation est appelée agrégat et cette Licence ne s'applique pas aux autres travaux indépendants compilés avec le Document s'ils ne sont pas eux-mêmes des travaux dérivés du Document. Si les exigences de la section 3 concernant les Textes de couverture sont applicables à ces copies du Document, et si le Document représente un volume inférieur à un quart du volume total de l'agrégat, les Textes de couverture du Document peuvent être placés sur des pages de couverture qui n'encadrent que le Document au sein de l'agrégat. Dans le cas contraire, ils doivent apparaître sur les pages de couverture de l'agrégat complet.

### 8. TRADUCTION

La traduction est considérée comme une forme de modification, vous pouvez donc distribuer les traductions du Document selon les termes de la section 4. Vous devez obtenir l'autorisation spéciale des auteurs des Sections inaltérables pour les remplacer par des traductions, mais vous pouvez inclure les traductions des Sections inaltérables en plus des textes originaux. Vous pouvez inclure une traduction de cette Licence à condition d'inclure également la version originale en anglais. En cas de contradiction entre la traduction et la version originale en anglais, c'est cette dernière qui prévaut.

### 9. RÉVOCATION

Vous ne pouvez pas copier, modifier, sous-licencier ou distribuer le Document autrement que selon les termes de cette Licence. Tout autre acte de copie, modification, sous-Licence ou distribution du Document est sans objet et vous prive automatiquement des droits que cette Licence vous accorde. En revanche, les personnes qui ont reçu de votre part des copies ou les droits sur le document sous couvert de cette Licence ne voient pas leurs droits révoqués tant qu'elles en respectent les principes.

### 10. RÉVISIONS FUTURES DE CETTE LICENCE

La Free Software Foundation peut publier de temps en temps de nouvelles versions révisées de cette Licence. Ces nouvelles versions seront semblables à la présente version dans l'esprit, mais pourront différer sur des points particuliers en fonction de nouvelles questions ou nouveaux problèmes. Voyez http://www.gnu.org/copyleft/ pour plus de détails.

Chaque version de cette Licence est dotée d'un numéro de version distinct. Si un Document spécifie un numéro de version particulier de cette Licence, et porte la mention ou toute autre version ultérieure, vous pouvez choisir de suivre les termes de la version spécifiée ou ceux de n'importe quelle version ultérieure publiée par la Free Software Foundation. Si aucun numéro de version n'est spécifié, vous pouvez choisir n'importe quelle version officielle publiée par la Free Software Foundation.

### Addendum

Pour utiliser cette Licence avec un document que vous avez écrit, incorporez une copie du texte de cette Licence en anglais et placez le texte ci-dessous juste après la page de titre :

> Copyright © 2010 Bruno Brouard.

> Permission vous est donnée de copier, distribuer et/ou modifier ce document selon les termes de la Licence GNU Free Documentation License, Version 1.1 ou ultérieure publiée par la Free Software Foundation ; avec les sections inaltérables suivantes LISTE DES TITRES DES SECTIONS INALTÉRABLES, avec le texte de première page de couverture suivant TEXTE DE PREMIÈRE PAGE DE COUVERTURE et avec le texte de dernière page de couverture suivant TEXTE DE DERNIÈRE PAGE DE COUVERTURE. Une copie de cette Licence est incluse dans la section appelée GNU Free Documentation License de ce document.

Si votre Document ne comporte pas de section inaltérable écrivez pas de section inaltérable au lieu de la liste des sections inaltérables. Si votre Document ne comporte pas de texte de première page de couverture, écrivez pas de texte de première page de couverture au lieu de texte de première page de couverture suivant TEXTE DE PREMIÈRE PAGE DE COUVERTURE ; de même pour le texte de dernière page de couverture.

Si votre Document contient des exemples non triviaux de code programme, nous recommandons de distribuer ces exemples en parallèle sous Licence GNU General Public License, qui permet leur usage dans les logiciels libres.