Personal tools
gvSIG Desktop
gvSIG Desktop

Cached time 11/21/13 16:55:13 Clear cache and reload

 
Document Actions

Generación de documentación e informes

by Cèsar Ordiñana last modified 2010-08-27 13:59

Cómo generar documentación como javadoc e informes sobre el proyecto desde maven

Maven permite la generación de documentación a partir de los fuentes de un
proyecto, como por ejemplo el *javadoc*.

Para ello existen una serie de *plugins* especiales de maven para la 
generación de informes.

Por ejemplo, para generar el javadoc usaremos el plugin correspondiente
de la siguiente forma::

  mvn javadoc:javadoc

Además de la generación de informes individuales, maven permite la 
generación de lo que llaman el *site*. Este consiste en un conjunto
de páginas de informes de maven enlazadas, con un menú que nos permite
navegar por todos los documentos generados.

De hecho, este mini website generado con maven es lo que emplean muchos
de los proyectos Java de apache como website del proyecto.

Para los proyectos de gvSIG, se ha preconfigurado una serie de plugins
con las opciones adecuadas del proyecto. Además, existen una serie de
páginas que muestran información extraída del archivo *pom.xml* del
proyecto, por lo que será importante completar y mantener actualizada
dicha información.

En los proyectos que se generen usando los arquetipos de maven, el archivo
*pom.xml* ya lleva los atributos necesarios predefinidos, a falta de
rellenar y completar con valores reales.

Para generar el site invocaremos el objetivo::

  mvn site

Esto nos generará la documentación dentro de nuestro proyecto, en la carpeta::

  target/site

**TODO**

- Links javadoc, la variable *site-repository* y referencias entre proyectos.

- Publicación del site en el servidor público de gvSIG.

View source document


Powered by Plone CMS, the Open Source Content Management System

This site conforms to the following standards: