Building Qt Documentation/es

From Qt Wiki
Jump to: navigation, search
This article may require cleanup to meet the Qt Wiki's quality standards. Reason: Auto-imported from ExpressionEngine.
Please improve this article if you can. Remove the {{cleanup}} tag and add this page to Updated pages list after it's clean.

Spanish English Русский Italiano

Este es un articulo en progreso

Creando documentación con Qt.

Para información hacer de como escribir documentación para Qt, vea la pagina Writing Qt Documentation.

Compilando qdoc3

qdoc3 se basa en una compilación normal de Qt, porque es necesario para generar la documentación de Qt. Esto significa que, para muchos desarrolladores, qdoc3 viene instalado junto a otras herramientas de Qt.

Ejecutando qdoc3

Hay dos manera de compilar documentación en Qt.

Usando Qt Build System

En la linea de comandos, posiciones en el directorio raíz de el árbol de compilación he invoque la regla docs build.

Por ejemplo en plataformas Linux/Unix:

cd path/to/qt-build
make docs

En Windows debera usar la tool nativa nmake :

cd path\to\qt-build
nmake docs

Ejecutando qdoc3 directamente

Si tiene a qdoc3 ya compilado, puede correrlo directamente para generar la documentación.

En la linea de comandos, establezca la variable de entorno QTDIR and QT_SOURCE_TREE para que haga referencia a la raíz del directorio del árbol de código. Luego ingrese a las raíz de el árbol compilado y ejecute qdoc3.

Por ejemplo en plataformas Linux/Unix:

cd path/to/qt-build
bin/qdoc3 tools/qdoc3/test/qt.qdocconf

Compilando qdoc3 con una compilación mínima de Qt.

Lo ideal seria compilar el conjunto mínimo de bibliotecas Qt requeridas por qdoc3 con una simple regla de compilación. Sin embargo, actualmente es necesario recurrir a varias reglas de generación para obtener las bibliotecas Qt necesarias para compilar qdoc3. En el directorio raíz del árbol de construcción, invocar las reglas siguientes.

Por ejemplo en plataformas Linux/Unix:

make sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3

En Windows:

nmake sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3