# Manual de GTK-Doc

1.12

Manual del usuario para desarrolladores con instrucciones del uso de GTK-Doc.

Chris
Lyttle

                chris@wilddev.net

Dan
Mueth

                d-mueth@uchicago.edu

Stefan
Kost

                ensonic@users.sf.net

Proyecto GTK-Doc

    gtk-doc-list@gnome.org

2000, 2005, 2007-2009
Dan Mueth, Chris Lyttle y Stefan Kost
2009
Francisco Javier F. Serrador (serrrador@svn.gnome.org)
2009
Jorge González (jorgegonz@svn.gnome.org)
2009
Daniel Mustieles (daniel.mustieles@gmail.com)

Se concede autorización para copiar, distribuir o modificar este documento según los términos de la GNU Free Documentation License, Versión 1.1, o cualquier otra versión posterior publicada por Free Software Foundation sin secciones invariables, textos de portada ni textos de contraportada. Se incluye una copia de la licencia.

Muchos de los nombres usados por compañías para distinguir sus productos y servicios se mencionan como marcas comerciales. Donde aparezcan dichos nombres en cualquier documentación GNOME, y para que los miembros del proyecto de documentación las reconozcan dichas marcas comerciales, dichos nombres se imprimen en mayúsculas o iniciales mayúsculas.

1.13
18 December 2009
1.12
18 December 2009
1.11
16 Novemebr 2008
mal
Migración de GNOME doc-utils

## Introducción

Este capítulo introduce GTK-Doc y proporciona una visión general de lo que es y cómo usarlo.

### ¿Qué es GTK-Doc?

GTK-Doc se usa para documentar código C. Generalmente se usa para documentar la API pública de bibliotecas, tales como las bibliotecas GTK+ y de GNOME. Pero también se puede usar para documentar código de aplicaciones.

### ¿Cómo funciona GTK-Doc?

GTK-Doc funciona usando documentación de las funciones ubicadas dentro de los archivos de fuentes en bloques de comentarios especialmente formateados, o documentación añadida a los archivos de plantillas que GTK-Doc usa (aunque debe notar que GTK-Doc sólo documentará las funciones declaradas en los archivos de cabecera; no produce salida para funciones estáticas).

GTK-Doc consiste en un número de scripts en Perl, cada uno realiza un paso diferente en el proceso.

Existen 5 pasos importantes en el proceso:

1. Escribir la documentación. El autor rellena los archivos de fuentes con la documentación para cada función, macro, unión, etc. (En el pasado la información se introducía en archivos de plantillas, lo que ya no se recomienda).

2. Obtener información acerca del código gtkdoc-scan analiza los archivos de cabecera del código buscando declaraciones de funciones, macros, enumeraciones, estructuras y uniones. Crea el archivo `<module>-decl-list.txt` conteniendo una lista de las declaraciones, ubicándolas en secciones de acuerdo con el archivo de cabecera en el que están. Durante la primera ejecución este archivo se copia en `<module>-sections.txt`. El autor puede reordenar las secciones y el orden de las declaraciones en ellas, para producir la salida deseada. El segundo archivo que genera es `<module>-decl.txt`. Este archivo contiene las declaraciones completas que encontró el análisis. Si por alguna razón un programador quisiese que algunos símbolos apareciesen en los documentos, donde el análisis no puede encontrar la declaración completa o la declaración debería aparecer de forma diferente, puede introducir entradas de forma similar a las que hay en `<module>-decl.txt` dentro de `<module>-overrides.txt`. También se puede usar gtkdoc-scanobj para consultar dinámicamente una biblioteca acerca de las subclases GtkObject que exporta. Ahorra información acerca de la posición de cada objeto en la jerarquía de clases y acerca de cualquier señal y argumentos GTK que proporciona.

3. Generar los archivos «plantilla». gtkdoc-mktmpl crea un número de archivos en el subdirectorio `tmpl/`, usando la información obtenida en el primer paso. (Note que esto se puede ejecutar de forma separada. Intentará asegurarse de que la documentación nunca se pierde.)

   Ya que las plantillas de gtk-doc 1.9 se pueden evitar. Animamos a la gente a que mantenga la documentación en el código. gtkdocize ahora soporta una opción `--flavour no-tmpl` que elige un archivo makefile que omite completamente el uso de tmpl. Si nunca ha cambiado a mano el archivo tmpl, elimine el directorio una vez.

4. Generar el GSML/XML y el HTML.gtkdoc-mkdb convierte los archivos de plantilla en archivos SGML o XML en el subdirectorio `sgml/` o `xml/`. Si el código fuente contiene documentación de funciones, usando los bloques especiales de comentarios, entonces se mezclarán aquí. Si no se usan archivos tmpl sólo obtiene los documentos de los fuentes y los datos obtenidos en introspección. gtkdoc-mkhtml convierte los archivos SGML en archivos HTML en el subdirectorio `html/`. Los archivos en el subdirectorio `sgml/` o `xml/` y `html/` siempre se sobreescriben. No se deberían editar directamente.

5. Arreglar referencias cruzadas entre documentos. Después de instalar los archivos HTML se puede ejecutar gtkdoc-fixxref para arreglar cualquier referencia cruzada entre documentos separados. Por ejemplo, la documentación GTK+ contiene muchas referencias cruzadas a tipos documentados en el manual de GLib. Al crear los archivadores «tarball» para su distribución, gtkdoc-rebase convierte todos los enlaces externos en enlaces web. Al instalar la documentación distribuida (pregenerada) la misma aplicación intentará convertir de nuevo los enlaces, esta vez a enlaces locales (donde esa documentación está instalada).

### Obtener GTK-Doc

#### Requerimientos

Perl v5: los scripts principales están en Perl.

DocBook DTD v3.0: Este es el DocBook SGML DTD. http://www.ora.com/davenport

Jade v1.1: Este es el procesador DSSSL para convertir SGML a varios formatos. http://www.jclark.com/jade

Hojas de estilo DocBook modulares: Éste es el código DSSSL para convertir DocBook a HTML (y otros cuantos formatos). Se usa junto con jade. El código DSSSL está algo personalizado, en GTK-Doc dsl, para colorear el código de listas/declaraciones del programa y soportar índices de referencias cruzadas globales en el HTML generado. http://nwalsh.com/docbook/dsssl.

docbook-to-man: Si quiere crear páginas man desde el DocBook. «translation spec» se ha personalizado un poco para capitalizar la sección de cabeceras y añadir un título de «Biblioteca GTK» en la parte superior de las páginas y la fecha de revisión al final. Existe un enlace acerca de esto en http://www.ora.com/davenport. NOTA: Esto aún no funciona.

#### Instalación

No existe ningún sitio estándar donde se instalan las hojas de estilo modulares de DocBook.

El script de configuración de gtk-doc busca estos tres directorios automáticamente:

`/usr/lib/sgml/stylesheets/nwalsh-modular` (usado por RedHat)

`/usr/lib/dsssl/stylesheets/docbook` (usado por Debian)

`/usr/share/sgml/docbkdsl` (usado por SuSE)

Si tiene las hojas de estilo instaladas en algún otro sitio, deberá configurar gtk-doc usando la opción: `--with-dsssl-dir=<RUTA_AL_DIRECTORIO_DE_NIVEL_SUPERIOR_DE_LAS_HOJAS_DE_ESTILO>`

### Acerca de GTK-Doc

(ARRÉGLAME)

(Historia, autores, páginas web, licencias, planes futuros, comparación con otros sistemas similares.)

### Acerca de este manual

(ARRÉGLAME)

(a quién está dirigido, dónde puede obtenerse, licencia)

## Configurando su proyecto

Las siguientes secciones describen los pasos que realizar para integrar GTK-Doc en su proyecto. Estas secciones asumen que se trabaja en un proyecto llamado «meep». Este proyecto contiene una biblioteca llamada «libmeep» y una aplicación final de usuario llamada «meeper».

### Configurar el esquema de la documentación

Bajo su directorio de nivel superior cree carpetas llamadas docs/reference (de esta forma también puede tener docs/help para la documentación final de usuario). Se recomienda crear otro subdirectorio con el nombre doc-package. Para paquetes con una sola biblioteca este paso no es necesario.

Esto después aparecerá como se muestra debajo:

#### Ejemplo de estructura de directorios

    meep/
      docs/
        reference/
          libmeep/
          meeper/
      src/
        libmeep/
        meeper/

### Integración con autoconf

Muy fácil, simplemente añada una línea a su script `configure.ac`.

#### Integración con autoconf

    # check for gtk-doc
    GTK_DOC_CHECK(1.9)

Además de comprobar la versión de GTK-Doc necesaria, esto añade dos claves:

1. --with-html-dir=RUTA: ruta a los documentos instalados

2. --enable-gtk-doc: usar gtk-doc para construir la documentación

GTK-Doc está desactivado de forma predeterminada. Recuerde pasar la opción `«--enable-gtk-doc»` en la siguiente ejecución de `configure`. De otra forma, la documentación pregenerada se instala (lo que tiene sentido para usuarios, pero no para desarrolladores).

Aún más, se recomienda que tenga la siguiente línea en su script `configure.ac`. Esto permite que `gtkdocize` copie automáticamente la definición del macro para `GTK_DOC_CHECK` a su proyecto.

#### Preparación para gtkdocize

    AC_CONFIG_MACRO_DIR(m4)

### Integración con automake

Primero copie el archivo `Makefile.am` del subdirectorio de ejemplos de gtkdoc-sources al directorio de documentación de la API de su proyecto (`./docs/reference/<paquete>`). Si tiene varios paquetes de documentación, repítalo para cada uno de ellos.

El siguiente paso es editar la configuración dentro de `Makefile.am`. Todos los ajustes tienen un comentario encima que describe su propósito. Muchos ajustes son opciones adicionales pasadas a las respectivas herramientas. Cada herramienta tiene una variable de la forma `<NOMBRE_DE_LA_HERRAMIENTA>_OPCIONES`. Todas las herramientas soportan `--help` para listar los parámetros que soportan.

Puede que también quiera activar GTK-Doc para el objetivo distcheckmate. Simplemente añada la línea mostrada en el siguiente ejemplo a su nivel superior de `Makefile.am`:

#### Activar gtk-doc durante make distcheck

    DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc

### Integración con autogen

La mayoría de los proyectos tienen un script `autogen.sh` para configurar la infraestructura de construcción después de hacer un «checkout» desde los sistemas de control de versiones (tales como cvs). GTK-Doc tiene una herramienta llamada `gtkdocize` que se puede usar en tal script. Se debería ejecutar antes que autoheader, automake o autoconf.

#### Ejecutar gtkdocize desde autogen.sh

    gtkdocize || exit 1

Al ejecutar `gtkdocize` se copia `gtk-doc.make` a la raíz de su proyecto (o cualquier directorio especificado por la opción --docdir). También comprueba su script de configuración para la invocación de `GTK_DOC_CHECK`.

Históricamente GTK-Doc generaba plantillas de archivos donde los desarrolladores introducían los documentos. Al final esto resulto no ser muy bueno. Desde las primeras versiones GTK-Doc también podría obtener toda la documentación desde los comentarios del código. Desde GTK-Doc 1.9 se pueden omitir las plantillas. Se anima a los desarrolladores a mantener su documentación en el código. gtkdocize ahora soporta una opción «--flavour=no-tmpl» que elije un makefile que omite completamente el uso de plantillas. Si nunca ha cambiado un archivo tmpl (plantilla) a mano, elimine el directorio una vez.

### Ejecutar la construcción de la documentación

Después de los pasos anteriores es hora de ejecutar el constructor. Primero se debe volver a ejecutar `autogen.sh`. Si este script ejecuta configure automáticamente, entonces debe pasar la opción `--enable-gtk-doc`. De otra forma, ejecute posteriormente `configure` con esta opción.

El primer make genera diversas líneas adicionales en los directorios de documentación. Las importantes son: `<paquete>.types`, `<paquete>-docs.sgml`, `<paquete>-sections.txt`.

#### Ejecutar la construcción de la documentación

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

Ahora puede apuntar su navegador a `docs/reference/<paquete>/index.html`. Sí, aún es un poco decepcionante. Pero espere, durante el siguiente capítulo aprenderá a rellenar las páginas con información.

### Integración con los sistemas de control de versiones

Como regla principal, son los archivos que edita, los que deberían estar bajo el control de versiones. Para proyectos típicos son los archivos: `<paquete>.types`, `<paquete>-docs.sgml`, `<paquete>-sections.txt` y `Makefile.am`.

## Documentar el código

GTK-Doc usa código fuente comentado con una sintaxis especial para documentar el código. Además obtiene información acerca de la estructura de su proyecto de otras fuentes. En la siguiente sección encontrará información acerca de la sintaxis de los comentarios.

### Ubicación de la documentación

En el pasado la mayoría de la documentación se debía rellenar en campos dentro del directorio `tmpl`. Esto tiene las desventajas de que la información. Esto tiene las desventajas de que la información no se actualiza muy a menudo y que el archivo tiene tendencia a causar conflictos con los sistemas de control de versiones.

Para evitar los problemas anteriormente mencionados, se sugiere dejar la documentación dentro de los fuentes. Este manual sólo describe esta forma de documentar el código.

### Comentarios de la documentación

Un comentario de varias líneas que comienza con un «*» adicional marca un bloque de documentación que GTK-Doc tools procesarán.

#### Bloque de comentario de GTK-Doc

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

El «identificador» es una línea con el nombre del elemento relacionado con el comentario. La sintaxis difiere un poco dependiendo del elemento. (Por hacer: añadir una tabla mostrando los identificadores)

El bloque de «Documentación» también es diferente para cada tipo de símbolo. Los tipos de símbolos que obtienen parámetros tales como funciones o macros, tienen primero las descripciones seguidas por una línea blanca (exactamente un «*»). Después siguen las descripciones detalladas. Todas las líneas (fuera de los programas; listaso y CDATA de la secciones) que solo contengan un « *» (asterisco con espacio) son convertidos en párrafos. Si no quiere un espaciado de párrafo, cámbielo a un « * » (espacio-asterisco-espacio).

Una ventaja del hipertexto sobre el texto plano es la capacidad de tener enlaces en el documento. Escribir las marcas adecuadas para un enlace puede ser tedioso aunque GTK-Doc le ayuda proporcionando abreviaturas útiles.

- Use función() para referirse a funciones o macros que toman argumentos.

- Use @parámetro para referirse a parámetros. Úselo también al referirse a parámetros de otras funciones, relacionados al que se describe.

- Use %constant para referirse a una constante, ej: %G_TRAVERSE_LEAFS.

- Use #símbolo para referirse a otro tipo de símbolos, como por ejemplo estructuras, enumeraciones y macros que no toman argumentos.

- Use #Object::signal para referirse a una señal de GObject

- Use #Object:property para referirse a una propiedad de GObject

- Use #Struct.field para referirse a un campo dentro de una estructura

Si necesita usar los caracteres especiales «()», «@», «%», o «#» en su documentación sin que GTK-Doc los cambie, puede usar las entidades XML "amp;lpar;" "amp;rpar;" "amp;commat;" "&percnt;" y "&num;" respectivamente o escaparlas con una contrabarra doble «\».

DocBook puede hacer más que insertar enlaces. Puede tener listas, tablas y ejemplos. Para activar el uso de etiquetas SGML/XML dentro de comentarios en la documentación debe tener `--sgml-mode` en la variable MKDB_OPTIONS dentro de `Makefile.am`.

Tal y como se ha mencionado antes, la documentación anterior de GTK-Doc es para documentar la API pública .Por ello, no se puede escribir documentación para los símbolos estáticos. No obstante es una buena práctica comentar los símbolos. Esto ayuda a que otros entiendan su código. Por ello se recomienda comentarlos usando comentarios normales (sin el segundo «*» en la primera línea). Si la función, posteriormente, se debe hacer pública, todo lo que el programador debe hacer es añadir otro «*» en el bloque de comentario e introducir el nombre del símbolo en la parte derecha dentro del archivo de secciones.

### Documentar secciones

Cada sección del documento contiene información acerca de una clase o un módulo. Para introducir el componente puede escribir un bloque de sección. La descripción corta además se usa dentro de la tabla de contenidos.

#### Bloque de comentarios en una sección

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

SECCIÓN <nombre>

  El nombre enlaza la sección de la documentación con la parte respectiva en el archivo `<package>-sections.txt`. El nombre aquí proporcionado debería coincidir con la etiqueta <ARCHIVO> en el archivo `<package>-sections.txt`.

@short_description

  Una línea descrita en la sección, que después aparece tras los enlaces en el TOC y en la página de la sección.

@see_also

  Una lista de símbolos relacionados con esta sección.

@stability

  Esta API tiene una descripción informal del nivel de estabilidad. Se recomienda el uso de uno de estos términos:

  - Estable: La intención de una interfaz estable es la de permitir que terceras partes arbitrarias desarrollen aplicaciones para esas interfaces, las liberen, y confíen que que se podrán ejecutar en todas las publicaciones menores del producto (después de que se introdujese la interfaz en una de ellas, y dentro de la misma versión principal de la publicación). Incluso en publicaciones importantes no se espera que existan cambios incompatibles, y de haberlos habrá buenas razones para ello.

  - Inestable: Las interfaces inestables son experimentales o de transición. Generalmente se usan para dar a los desarrolladores externos acceso a tecnología nueva o cambiante, o para proporcionar una solución a un problema, anticipándose a una solución más general. No se realizan reclamaciones acerca de la compatibilidad del código o del binario desde una publicación menor a la siguiente.

  - Privada: Una interfaz que se puede usar en la pila de GNOME en si misma, pero que no está documentada para usuarios finales. Tales funciones sólo se deberían usar de formas especificadas y documentadas.

  - Interna: Una interfaz que es interna a un módulo y no requiere documentación para el usuario final. Se asume que las funciones que están sin documentar son internas.

@include

  Los archivos `#include` para mostrar en la sección del resumen (una lista separada por comas), sobreescribiendo el valor global del archivo de secciones o de la línea de comandos. Este elemento es opcional.

ARREGLAR tener @title aquí pondrá este título en una nueva sección de archivo generada, pero después se quedará obsoleto (¿es así?)

Para evitar recompilaciones innecesarias después de cambios en la documentación ponga los documentos de sección en el código fuente C cuando sea posible.

### Documentar símbolos

Cada símbolo (función, macro, estructura, enum, señal y propiedad) está documentado en un bloque separado. La mejor posición para el bloque es junto a la definición del símbolo de tal forma que sea fácil mantenerlos sincronizados. Por ello las funciones generalmente se documentan en el código C y las macros, estructuras y enum en el archivo de cabecera.

#### Bloque de comentario de función

    /**
     * function_name:
     * @par1:  description of parameter 1. These can extend over more than
     * one line.
     * @par2:  description of parameter 2
     *
     * 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.
     */

Devuelve:

  Párrafo que describe el resultado devuelto.

Obsoleto:

  Párrafo que denota que esta función no se debería usar más. La descripción debería informar al lector de la nueva API.

Desde:

  Descripción desde qué versión del código está disponible la API.

GTK-Doc asume que todos los símbolos (macros, funciones) que empiezan por «_» son privados. Se tratan como funciones estáticas.

(ARRÉGLAME) (estabilidad) (glib-enums, ...)

#### Bloque de comentario de propiedad

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

#### Bloque de comentario de señal

    /**
     * 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[FOOBARIZE] =
      g_signal_new ("foobarize",
                    ...

#### Bloque de comentario de estructura

    /**
     * FooWidget:
     * @bar: some #gboolean
     *
     * This is the best widget, ever.
     */
    typedef struct _FooWidget {
      GtkWidget parent;
      /*< public >*/
      gboolean bar;
    } FooWidget;

### Etiquetas DocBook útiles

Aquí están varias etiquetas de DocBook muy útiles al documentar código.

Para enlazar otra sección en GTK docs:

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

. El enlace es el id SGML en el elemento superior de la página a la que quiere enlazar. Para la mayoría de las páginas esta es la parte («gtk», «gdk», «glib») y después el título de página («Tablas hash»). Para los widgets es simplemente el nombre de la clase. Los espacios y guiones bajos se convierten a «-» para ajustarse a SGML.

Para referirse a una función externa, ej. una función de C estándar:

    <function>...</function>

Para incluir un código de ejemplo:

    <example>
      <title>Using a GHashTable.</title>
      <programlisting>
          ...
      </programlisting>
    </example>

o posiblemente este, para fragmentos de código muy cortos que no necesitan título:

    <informalexample>
      <programlisting>
      ...
      </programlisting>
    </informalexample>

. Para el último, GTK-Doc también soporta abreviación: |[ ... ]|

Para incluir listas de topos:

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

Para incluir una nota que sobresale del texto:

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

Para referirse a un tipo:

    <type>unsigned char</type>

Para referirse a una estructura externa (no una descrita en la documentación de GTK):

    <structname>XFontStruct</structname>

Para referirse a un campo o a una estructura:

    <structfield>len</structfield>

Para referirse a un nombre de clase, se podría usar:

    <classname>GtkWidget</classname>

pero probablemente estará usando #GtkWidget en su lugar (para crear automaticamenteun enlace a la página GtkWidget; consulte abreviaciones).

Para enfatizar un texto:

    <emphasis>This is important</emphasis>

Para uso de nombres de archivo:

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

## Rellenar campos adicionales

Existen tres archivos adicionales que deben mantenerse junto con los comentarios en línea del código fuente: `<paquete>.types`, `<paquete>-docs.sgml`, `<paquete>-sections.txt`.

### Editar los tipos de archivo

Si su biblioteca o aplicación incluye GtkObjects/GObjects puede querer que sus señales, argumentos y/o parámetros y posición en la jerarquía se muestre en la documentación. Todo lo que debe hacer es listar las funciones `xxx_get_type` junto con sus «include» en el archivo `<paquete>.types`.

#### Fragmento de ejemplo de tipos de archivo

    #include <gtk/gtk.h>

    gtk_accel_label_get_type
    gtk_adjustment_get_type
    gtk_alignment_get_type
    gtk_arrow_get_type

Desde GTK-Doc 1.8 gtkdoc-scan puede genera esta lista. Simplemente añada «--rebuild-types» a SCAN_OPTIONS en el `Makefile.am`. Si usa esto no debería ejecutar dist sobre los tipos de archivo ni tenerlos bajo el control de versiones.

### Editar la sección maestra del documento

GTK-Doc produce documentación en DocBook SGML/XML. Cuando se procesan los comentarios en las líneas del código, las herramientas de GTK-Doc generan una página de documentación por clase o módulo en un archivo aparte. El documento maestro las incluye y ordena.

Puesto que GTK-Doc crea una documento maestro de plantilla, una posterior ejecución no lo tocará de nuevo. Esto significa que se puede estructurar libremente la documentación. Esto incluye agrupar páginas y añadir páginas adiciones. Ahora GTK-Doc tiene un entorno de pruebas, donde también el documento maestro se vuelve a crear desde cero. Es una buena idea mirarlo de vez en cuando para ver si se han introducido algunas mejoras.

No crear tutoriales como documentos adicionales. Solamente escriba capítulos adicionales. La ventaja de integrar directamente el tutorial para su biblioteca en la documentación de la API es que es fácil para el tutorial enlazar la documentación de símbolos. Además las posibilidades de actualizar el tutorial junto con la biblioteca son mayores.

¿Así que qué es lo que hay que cambiar en el documento maestro? Para empezar es muy poco. Existen algunos «placeholders» (texto entre corchetes) de los que habría que encargarse.

#### Cabecera del documento maestro

    <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>

### Editar el archivo de sección

El archivo de sección se usa para organizar la salida de la documentación por GTK-Doc. Aquí se especifica qué símbolos pertenecen a qué módulo o clase y el control de la visibilidad (pública o privada).

El archivo de sección es un archivo de texto plano con sintaxis parecida a XML (usando etiquetas). Se ignoran las líneas vacías y las líneas que comiencen con «#» se tratan como comentarios.

La etiqueta <FILE> ... </FILE> se usa para especificar el nombre del archivo, sin sufijo. Por ejemplo, usar «<FILE>gnome-config</FILE>» dará como resultado en la sección de declaraciones la salida `tmpl/gnome-config.sgml` en el archivo de plantilla, que se convertirá al archivo DocBook SGML `sgml/gnome-config.sgml` o al archivo DocBook XML `xml/gnome-config.xml`. (El nombre del archivo html está basado en el nombre del módulo y en el título de la sección, o para gobjects está basado en el nombre de clase de gobject convertido a minúscula.)

La etiqueta <TITLE> ... </TITLE> se usa para especificar el título de una sección. Sólo es útil antes de que las plantillas se creen inicialmente, ya que el título configurado en la plantilla lo sobreescribe.

Puede agrupar elementos en la sección usando la etiqueta <SUBSECTION>. Actualmente esto genera una línea en blanco entre subsecciones en la sección de resumen. También puede usar <SUBSECTION Standard> para declaraciones estándar de GObject (ej. funciones como g_object_get_type and macros como G_OBJECT(), G_IS_OBJECT() etc.). Actualmente éstas se han dejado fuera de la documentación. También puede usar <SUBSECTION Private> para declaraciones privadas que no producirán ninguna salida (esta es una manera práctica de evitar mensajes de advertencia sobre declaraciones sin usar). Si sus bibliotecas contienen tipos privados que no quiere que aparezcan en la jerarquía de objetos o en la lista de interfaces implementados o necesarios, añádalos a una subsección Privada.

También puede usar <INCLUDE> ... </INCLUDE> para especificar qué archivos #include se muestran en la sección de resumen. Contiene una lista de archivos #include separados por comas, sin las almohadillas. Si lo configura fuera de cualquier sección, actúa para todas las secciones hasta el final del archivo. Si lo configura dentro de una sección, sólo se aplica a esa sección.

## Controlar el resultado

Una ejecución de GTK-Doc genera archivos de informe dentro del directorio de la documentación. Los archivos generados se llaman `<package>-undocumented.txt`, `<package>-undeclared.txt` y `<package>-unused.txt`.Todos son archivos de texto plano y se pueden ver y posprocesar fácilmente.

El archivo `<package>-undocumented.txt` comienza con el resumen de cobertura de la documentación. Debajo hay dos secciones divididas por líneas vacías. La primera sección lista los símbolos incompletos o indocumentados. La segunda sección hace lo mismo para los documentos de sección. Las entradas incompletas son aquellas que tienen documentación pero dónde; p.e. se ha añadido un parámetro nuevo.

El archivo `<package>-undeclared.txt` lista símbolos proporcionados en el archivo `<package>-sections.txt`, pero no encontrados en los fuentes. Compruebe si se han eliminado o no se han escrito correctamente.

El archivo `<package>-unused.txt` lista nombres de símbolos, donde el analizador de GTK-Doc ha encontrado documentación, pero no sabe dónde ponerla. Esto significa que el símbolo no se ha añadido todavía al archivo `<package>-sections.txt`.

Activar o añadir la línea `TESTS=($GTKDOC_CHECK)` en el Makefile.am. Si como mínimo está instalado GTK-Doc 1.9, esto ejecutará comprobaciones de integridad durante la ejecución de make check.

## Preguntas más frecuentes

Pregunta
Respuesta
Sin jerarquía de clases.
Los objetos de la función_get_type() no se han introducido en el archivo `.types`.
Aún sin jerarquía de clases.
Nombres erróneos en el archivo de sección (consultar explicación)
Maldición, aún no hay una jerarquía de clases.
Es el nombre del objeto (nombre de la estructura de la instancia) parte de la sección normal (no ponga esto en Estándar o Privado).
Sin índice de símbolos.
ARREGLAR (etiqueta <index> en archivo sgml principal)
Los símbolos no se enlazan con su sección en el documento.
ARREGLAR (añadido #,% o () ?)
Una clase nueva no aparece en la documentación.
ARREGLAR (archivo de sección, archivo de tipos, archivo sgml principal)
Un símbolo nuevo no aparece en la documentación.
ARREGLAR (archivo de sección, comentarios del documento apropiado)
Parámetro descrito en el bloque de comentarios del código fuente pero no existe
Compruebe si el prototipo en la cabecera tiene nombres de parámetro diferentes de la fuente.
«ID» múltiples para la restricción enlazada: XYZ
El símbolo XYZ aparece dos veces en el archivo -sections.txt.
Elemento typename en namespac e«» encontrado en para, pero ninguna plantilla coincide.
Versión 1.1, marzo de 2000
2000
Free Software Foundation, Inc.

    Free Software Foundation, Inc. 51 Franklin Street, Suite 330, Boston, MA02110-1301EE. UU.

Se permite la copia y distribución de este documento de licencia, pero no se permite su modificación.

## GNU Free Documentation License

### 0. PREÁMBULO

El propósito de esta Licencia es permitir que un manual, libro de texto, u otro documento escrito sea libre en el sentido de libertad: asegurar a todo el mundo la libertad efectiva de copiarlo y redistribuirlo, con o sin modificaciones, de manera comercial o no. En segundo término, esta Licencia proporciona al autor y al editor una manera de obtener reconocimiento por su trabajo, sin que se le considere responsable de las modificaciones realizadas por otros.

Esta Licencia es de tipo copyleft, lo que significa que los trabajos derivados del documento deben a su vez ser libres en el mismo sentido. Complementa la Licencia Pública General de GNU, que es una licencia tipo copyleft diseñada para el software libre.

Hemos diseñado esta Licencia para usarla en manuales de software libre, ya que el software libre necesita documentación libre: Un programa libre debe venir con los manuales que ofrezcan la mismas libertades que da el software. Pero esta licencia no se limita a manuales de software; puede ser usada para cualquier trabajo textual, sin tener en cuenta su temática o si se publica como libro impreso. Recomendamos esta licencia principalmente para trabajos cuyo fin sea instructivo o de referencia.

### 1. APLICABILIDAD Y DEFINICIONES

Esta Licencia se aplica a cualquier manual u otro trabajo que contenga un aviso colocado por el poseedor del copyright diciendo que puede distribuirse bajo los términos de esta Licencia. El Documento, abajo, se refiere a cualquier manual o trabajo. Cualquier miembro del público es un licenciatario,y será referido como Usted.

Una Versión Modificada del Documento significa cualquier trabajo que contenga el Documento o una porción del mismo, ya sea una copia literal o con modificaciones y/o traducciones a otro idioma.

Una Sección Secundaria es un apéndice con título o una sección preliminar del Documento que trata exclusivamente de la relación entre los autores o editores y el tema general delDocumento que trata exclusivamente con la relación entre los editores o autores del Documento con el asunto general del Documento (o asuntos relacionados) y no contiene nada que pueda considerarse dentro del tema principal. (Por ejemplo, si el Documento es en parte un libro de texto de matemáticas, una Sección Secundaria no explicará nada de matemáticas.) La relación puede ser una conexión histórica con el asunto o temas relacionados, o una opinión legal, comercial, filosófica, ética o política acerca de ellos.

Las Secciones Invariantes son ciertas Secciones Secundarias cuyos títulos son designados como Secciones Invariantes en la nota que indica que el Documento se publica bajo esta Licencia.

Los Textos de Cubierta son ciertos pasajes cortos de texto que se listan como Textos de Cubierta Delantera o Textos de Cubierta Trasera en la nota que indica que el Documento se publica bajo esta Licencia.

Una copia Transparente del Documento, significa una copia para lectura en máquina, representada en un formato cuya especificación está disponible al público en general, cuyo contenido puede ser visto y editados directamente con editores de texto genéricos o (para imágenes compuestas por píxeles) con programas genéricos de manipulación de imágenes o (para dibujos) con algún editor de dibujos ampliamente disponible, y que sea adecuado como entrada para formateadores de texto o para su traducción automática a formatos adecuados para formateadores de texto. Una copia hecha en un formato definido como Transparente, pero cuyo marcaje o ausencia de él haya sido diseñado para impedir o dificultar modificaciones posteriores por parte de los lectores no es Transparente. Una copia que no es Transparente se denomina Opaca.

Como ejemplos de formatos adecuados para copias Transparentes están ASCII puro sin marcaje, formato de entrada de Texinfo, formato de entrada de LaTeX, SGML o XML usando una DTD disponible públicamente, y HTML, PostScript o PDF simples, que sigan los estándares y diseños para que los modifiquen personas.Los formatos Opacos incluyen formatos propietarios que pueden ser leídos y editados únicamente en procesadores de textos propietarios, SGML o XML para los cuáles las DTD y/o herramientas de procesamiento no estén ampliamente disponibles, y HTML, PostScript o PDF generados por algunos procesadores de textos sólo como salida.

La Portada significa, en un libro impreso, la página de título, más las páginas siguientes que sean necesarias para mantener legiblemente el material que esta Licencia requiere en la portada. Para trabajos en formatos que no tienen página de portada como tal, Portadasignifica el texto cercano a la aparición más prominente del título del trabajo,precediendo el comienzo del cuerpo del texto.

### 2. COPIA VERBATIM

Usted puede copiar y distribuir el Documento en cualquier medio, sea en forma comercial o no, siempre y cuando proporcione esta Licencia, las notas de copyright y la nota que indica que esta Licencia se aplica al Documento reproduciéndola en todas las copias y que usted no añada ninguna otra condición a las expuestas en esta Licencia. Usted no puede usar medidas técnicas para obstruir o controlar la lectura o copia posterior de las copias que usted haga o distribuya. Sin embargo, usted puede aceptar compensación a cambio de las copias. Si distribuye un número suficientemente grande de copias también deberá seguir las condiciones de la sección 3.

Usted también puede prestar copias, bajo las mismas condiciones establecidas anteriormente, y puede exhibir copias públicamente.

### 3. COPIAR EN CANTIDAD

Si publica copias impresas del Documento que sobrepasen las 100, y la nota de licencia del Documento exige Textos de Cubierta, debe incluirlas copias con cubiertas que lleven en forma clara y legible todos esos Textos de Cubierta: Textos de Cubierta Delantera en la cubierta delantera y Textos de Cubierta Trasera en la cubierta trasera. Ambas cubiertas deben identificarlo a Usted clara y legiblemente como editor de tales copias. La cubierta debe mostrar el título completo con todas las palabras igualmente prominentes y visibles. Además puede añadir otro material en las cubiertas. Las copias con cambios limitados a las cubiertas, siempre que conserven el título del Documento y satisfagan estas condiciones, pueden considerarse como copias literales en todos los aspectos.

Si los textos requeridos para la cubierta son muy voluminosos para que ajusten legiblemente, debe colocar los primeros (tantos como sea razonable colocar) en la verdadera cubierta y situar el resto en páginas adyacentes.

Si Usted publica o distribuye copias Opacas del Documento cuya cantidad exceda las 100, debe incluir una copia Transparente, que pueda ser leída por una máquina, con cada copia Opaca, o bien mostrar, en cada copia Opaca, una dirección de red donde cualquier usuario de la misma tenga acceso por medio de protocolos públicos y estandarizados a una copia Transparente del Documento completa, sin material adicional. Si usted hace uso de la última opción, deberá tomar las medidas necesarias, cuando comience la distribución de las copias Opacas en cantidad, para asegurar que esta copia Transparente permanecerá accesible en el sitio establecido por lo menos un año después de la última vez que distribuya una copia Opaca de esa edición al público (directamente o a través de sus agentes o distribuidores).

Se solicita, aunque no es requisito, que se ponga en contacto con los autores del Documento antes de redistribuir gran número de copias, para darles la oportunidad de que le proporcionen una versión actualizada del Documento.

### 4. MODIFICACIONES

Puede copiar y distribuir una Versión Modificada del Documento bajo las condiciones de las secciones 2 y 3 anteriores, siempre que Usted libere la Versión Modificada bajo esta misma Licencia, con la Versión Modificada haciendo el rol del Documento, por lo tanto dando Licencia de distribución y modificación de la Versión Modificada a quienquiera posea una copia de la misma. Además, debe hacer lo siguiente en la Versión Modificada:

- #### A

  Usar en la Portada (y en las cubiertas, si hay alguna) un título distinto al del Documento y de sus versiones anteriores (que deberían, si hay alguna, estar listadas en la sección de Historia del Documento). Puede usar el mismo título de versiones anteriores al original siempre y cuando quien las publicó originalmente otorgue permiso.

- #### B

  Listar en la Portada, como autores, una o más personas o entidades responsables de la autoría de las modificaciones de la Versión Modificada, junto con por lo menos cinco de los autores principales del Documento (todos sus autores principales, si hay menos de cinco), a menos que le eximan de tal requisito.

- #### C

  Mostrar en la Portada como editor el nombre del editor de la Versión Modificada

- #### D

  Conservar todas las notas de copyright del Documento.

- #### E

  Añadir una nota de copyright apropiada a sus modificaciones, adyacente a las otras notas de copyright.

- #### F

  Incluir, inmediatamente después de los avisos de copyright, una nota de licencia dando el permiso público para usar la Versión Modificada bajo los términos de esta Licencia, de la forma mostrada en el Adenda de más abajo.

- #### G

  Incluir, inmediatamente después de ese aviso de licencia, la lista completa de Secciones invariantes y de los Textos de Cubierta que sean requeridos en el aviso de Licencia del Documento original.

- #### H

  Incluir una copia sin modificación de esta Licencia.

- #### I

  Conservar la sección titulada Historia, conservar su Título y añadirle un elemento que declare al menos el título, el año, los nuevos autores y el editor de la Versión Modificada, tal como figuran en la Portada. Si no hay una sección titulada Historia en el Documento, crear una estableciendo el título, el año, los autores y el editor del Documento, tal como figuran en su Portada, añadiendo además un elemento describiendo la Versión Modificada, como se estableció en la sentencia anterior.

- #### J

  Conservar la dirección en red, si la hay, dada en el Documento para el acceso público a una copia Transparente del mismo, así como las otras direcciones de red dadas en el Documento para versiones anteriores en las que estuviese basado. Pueden ubicarse en la sección Historia. Se puede omitir la ubicación en red de un trabajo que haya sido publicado por lo menos cuatro años antes que el Documento mismo, o si el editor original de dicha versión da permiso.

- #### K

  En cualquier sección titulada Agradecimientos o Dedicatorias, conservar el título de la sección y conservar en ella toda la sustancia y el tono de los agradecimientos y/o dedicatorias incluidas por cada contribuyente.

- #### L

  Conservar todas las Secciones Invariantes del Documento, sin alterar su texto ni sus títulos. Los números de sección o equivalentes no se consideran parte de los títulos de la sección.

- #### M

  Borrar cualquier sección titulada Aprobaciones. Tales secciones no pueden estar incluidas en las Versiones Modificadas.

- #### N

  No cambiar el título de ninguna sección existente a Aprobaciones ni a uno que entre en conflicto con el de alguna Sección Invariante.

Si la Versión Modificada incluye secciones o apéndices nuevos que cualifiquen como Secciones Secundarias y no contienen ningún material copiado del Documento, puede opcionalmente designar algunas o todas esas secciones como invariantes. Para hacerlo, añada sus títulos a la lista de Secciones Invariantes en el aviso de licencia de la Versión Modificada. Tales títulos deben ser distintos de cualquier otro título de sección.

Puede añadir una sección titulada Aprobaciones, siempre que contenga únicamente aprobaciones de su Versión Modificada por otras fuentes --por ejemplo, observaciones de compañeros o que el texto ha sido aprobado por una organización como definición oficial de un estándar.

Puede añadir un pasaje de hasta cinco palabras como Texto de Cubierta Delantera y un pasaje de hasta 25 palabras como Texto de Cubierta Trasera al final de la lista de Texto de Cubierta en la Versión Modificada. Una entidad sólo puede añadir (o hacer que se añada) un pasaje al Texto de Cubierta Delantera y uno al de Cubierta Trasera. Si el Documento ya incluye un textos de cubiertas añadidos previamente por usted o por acuerdo previo con la entidad que usted representa, usted no puede añadir otro; pero puede reemplazar el anterior, con permiso explícito del editor anterior que agregó el texto anterior.

Con esta Licencia ni los autores ni los editores del Documento dan permiso para usar sus nombres para publicidad ni para asegurar o implicar aprobación de cualquier Versión Modificada.

### 5. COMBINAR DE DOCUMENTOS

Usted puede combinar el Documento con otros documentos liberados bajo esta Licencia, bajo los términos definidos en la sección section 4 más arriba para versiones modificadas, siempre que incluya en la combinación todas las Secciones Invariantes de todos los documentos originales, sin modificaciones, y las liste todas como Secciones Invariantes de su trabajo combinado en su aviso de licencia.

El trabajo combinado necesita contener solamente una copia de esta Licencia, y múltiples Secciones Invariantes idénticas pueden reemplazarse por una sola copia. Si hay múltiples Secciones Invariantes con el mismo nombre pero con contenidos diferentes, haga el título de cada una de estas secciones único añadiéndolo al final de este, entre paréntesis, el nombre del autor o de quien editó originalmente esa sección, si es conocido, o si no, un número único. Haga el mismo ajuste a los títulos de sección en la lista de Secciones Invariantes en la nota de licencia del trabajo combinado.

En la combinación, debe combinar cualquier sección titulada Historia de los distintos documentos originales, formando una sección titulada Historia; de la misma forma, combine cualquier sección titulada Reconocimientos y cualquier sección titulada Dedicatorias. Debe borrar todas las secciones tituladas Aprobaciones.

### 6. COLECCIONES DE DOCUMENTOS

Puede hacer una colección que conste del Documento y de otros documentos publicados bajo esta Licencia, y reemplazar las copias individuales de esta Licencia en todos los documentos por una sola copia que esté incluida en la colección, siempre que siga las reglas de esta Licencia para cada copia literal de cada uno de los documentos en cualquiera de los demás aspectos.

Puede extraer un solo documento de una de tales colecciones y distribuirlo individualmente bajo esta Licencia, siempre que inserte una copia de esta Licencia en el documento extraído, y siga esta Licencia en todos los demás aspectos relativos a la copia literal de dicho documento.

### 7. AGREGACIONES CON TRABAJOS INDEPENDIENTES

Una recopilación que conste del Documento o sus derivados y de otros documentos o trabajos separados e independientes, en cualquier soporte de almacenamiento o distribución, no cuenta como un todo como una Versión Modificada del Documento, siempre que no se reclame ningún derecho de copyright por la compilación. Dicha compilación se denomina un agregado, y esta Licencia no se aplica a otros trabajos autocontenidos incluidos con el Documento. teniendo en cuenta que son compilados, si no son los mismos trabajos derivados del Documento. Si el requisito de Texto de Cubierta de la sección 3 es aplicable a estas copias del Documento, entonces si el Documento es menor que un cuarto del agregado completo, los Textos de Cubierta del Documento pueden colocarse en cubiertas que enmarquen solamente el Documento dentro del agregado. En caso contrario deben aparecer en cubiertas impresas enmarcando todo el agregado.

### 8. TRADUCCIÓN

La traducción se considera un tipo de modificación, así que puede distribuir traducciones del Documento bajo los términos de la sección 4. Reemplazar las Secciones invariantes con traducciones requiere permiso especial de los mantenedores de la propietarios del copyright, pero puede incluir traducciones de algunos o todas las Secciones invariantes. Puede incluir una traducción de esta licencia proporcionada que además incluya la versión original de esta Sección invariante en adición de esta licencia. En caso de desacuerdo prevalecerá la versión original en inglés.

### 9. TERMINACIÓN

Usted no puede copiar, modificar, sublicenciar o distribuir el Documento salvo por lo permitido expresamente por esta Licencia. Cualquier otro intento de copia, modificación, sublicenciamiento o distribución del Documento es nulo, y dará por terminados automáticamente sus derechos bajo esa Licencia. Sin embargo, los terceros que hayan recibido copias, o derechos, de usted bajo esta Licencia no verán terminadas sus licencias, siempre que permanezcan en total conformidad con ella.

### 10. REVISIONES FUTURAS DE ESTA LICENCIA

La Free Software Foundation puede publicar versiones nuevas y revisadas de la Licencia de Documentación Libre GNU de vez en cuando. Dichas versiones nuevas serán similares en espíritu a la presente versión, pero pueden diferir en detalles para solucionar nuevos problemas o preocupaciones. Vea http://www.gnu.org/copyleft/.

Cada versión de la licencia tiene un número de versión. Si la Documentación especifica que el número particular de versión de esta Licencia o cualquier posterior versión aplicado sobre él, tiene la opción de seguir los términos y condiciones de cualquiera de esas versiones especificadas o de cualquiera de las versiones publicadas (no como borrador) por la Free Software Foundation. Si el Documento no especifica un número de versión de la licencia, puede elegir cualquier versión publicada (no como borrador) por la Free Software Foundation.

### Addendum

Para usar esta licencia en un documento que ha escrito, incluya una copia de la Licencia en el documento y ponga el siguiente copyright y las notas justo después del título de la página.

> Copyright AÑO SU NOMBRE.

> Se otorga permiso para copiar, distribuir y/o modificar este documento bajo los términos de la Licencia de Documentación Libre de GNU, Versión 1.1 o cualquier otra versión posterior publicada por la Free Software Foundation; con las Secciones Invariantes siendo su LISTE SUS TÍTULOS, con Textos de Cubierta Delantera siendo LISTA, y con los Textos de Cubierta Trasera siendo LISTA. Una copia de la licencia está incluida en la sección titulada GNU Free Documentation License.

Si no tiene Secciones Invariantes, escriba sin Secciones Invariantes en vez de decir cuáles son invariantes. Si no tiene Textos de Cubierta Frontal, escriba sin Textos de Cubierta Frontal; de la misma manera para Textos de Cubierta Trasera.

Si su documento contiene ejemplos de código de programa no triviales, recomendamos liberar estos ejemplos en paralelo bajo la licencia de software libre que usted elija, como la Licencia Pública General de GNU (GNU General Public License), para permitir su uso en software libre.