diff options
author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-12-03 11:05:10 -0600 |
---|---|---|
committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-12-03 11:05:10 -0600 |
commit | f7e7a923aca8be643f9ae6f7252f9fb27b3d2c3b (patch) | |
tree | 1f78ef53b206c6b4e4efc88c4849aa9f686a094d /tde-i18n-es/docs/tdevelop/tdevelop/documentation.docbook | |
parent | 85ca18776aa487b06b9d5ab7459b8f837ba637f3 (diff) | |
download | tde-i18n-f7e7a923aca8be643f9ae6f7252f9fb27b3d2c3b.tar.gz tde-i18n-f7e7a923aca8be643f9ae6f7252f9fb27b3d2c3b.zip |
Second part of prior commit
Diffstat (limited to 'tde-i18n-es/docs/tdevelop/tdevelop/documentation.docbook')
-rw-r--r-- | tde-i18n-es/docs/tdevelop/tdevelop/documentation.docbook | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/tde-i18n-es/docs/tdevelop/tdevelop/documentation.docbook b/tde-i18n-es/docs/tdevelop/tdevelop/documentation.docbook new file mode 100644 index 00000000000..5d0b3b367a2 --- /dev/null +++ b/tde-i18n-es/docs/tdevelop/tdevelop/documentation.docbook @@ -0,0 +1,73 @@ +<chapter id="documentation"> +<title +>Documentación</title> + +<para +>La documentación, desafortunadamente, es una de las cuestiones menos tenidas en cuenta en programación. Aún así, una vez configurada y bien mantenida, la documentación tanto interna como externa proporciona una ayuda inestimable. </para> + +<para +>La documentación posee múltiples aspectos. Existe <itemizedlist> + <listitem +><para +><emphasis +>documentación interna del proyecto</emphasis +>, consistente principalmente en <itemizedlist> + <listitem +><para +><emphasis +>comentarios</emphasis +> en archivos de cabecera y de código fuente </para +></listitem> + <listitem +><para +><emphasis +>documentación de la &API; interna</emphasis +> de su proyecto generada a partir de los archivos de código fuente de su programa por herramientas especiales, como &doxygen; </para +></listitem> + </itemizedlist> + </para +></listitem> + <listitem +><para +><emphasis +>documentación externa del proyecto</emphasis +>, que comprende, entre otros, <itemizedlist> + <listitem +><para +><emphasis +>documentación de la &API; externa</emphasis +> de, ⪚, bibliotecas comunes del sistema (&kde;, &Qt;, &etc;) </para +></listitem> + <listitem +><para +>cualquier otra documentación (manuales de lenguajes de programación, información general del sistema, artículos «cómo», y similares) </para +></listitem> + </itemizedlist> + </para +></listitem> +</itemizedlist> +</para> +<para +>Toda esta documentación debe ser fácil de mantener y estar disponible rápidamente cada vez que la necesite. &tdevelop; proporciona precisamente eso. </para> + +<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen --> + +<sect1 id="docbrowser"> +<title +>El navegador de la documentación</title> + + +<figure id="screenshot-doctreeview" float="1"> +<title +>Una captura del árbol de la documentación</title> +<mediaobject> +<imageobject +><imagedata fileref="doctreeview.png"/></imageobject> +</mediaobject> +</figure> + +</sect1 +> <!-- docbrowser --> + +</chapter +> <!-- documentation --> |