Usando DocFlex/Javadoc en Eclipse

Hola a todos, actualmente estoy haciendo una documentación de un proyecto de informática. Estoy casi terminando y estaba pensando en integrar la documentación javadoc (en html) en el texto (.doc).

Después de bucear un poco por la Web me encontré una herramienta que facilita esta tarea convirtiendo la salida de javadoc en RTF, no es justo lo que quería pero al menos podré hacer un copy-paste de una forma relativamente cómoda más adelante.

Docflex no es una herramienta gratuita, aunque sí se puede obtener un versión de prueba de 30 días desde la página oficial: http://www.filigris.com/products/docflex_javadoc/

Desde la página Web explican varias formas de utilizarla, así como de modificar las plantillas. En esta ocasión nos centraremos en explicar cómo se configura para ser utilizado desde Eclipse, puesto que en la página oficial viene mal explicado y me ha dado algún que otro dolor de cabeza.

  • Bien, para ello debemos descargarnos el archivo desde la sección de descargas de la página: http://www.filigris.com/downloads/license_agreement.php?pid=docflex-javadoc
  • Una vez descargado lo descomprimimos, donde queramos y abrimos Eclipse.
  • En Eclipse vamos a la opción de menú, Proyecto –> Generar Javadoc
  • Una vez dentro, seleccionamos la última opción en mi caso “Use custom doclet” (tengo Eclipse en Inglés)
    • En Javadoc commad: ruta donde se encuentra la orden javadoc (está dentro del JDK de Java)
    • En Doclet name: com.docflex.javadoc.Doclet con la D en mayúscula (!!)
    • En Doclet path name: ruta hasta el archivo docflex-javadoc.jar (dentro del archivo descargado de docflex, en la carpeta lib)

Os pongo una imagen de como lo configuré yo para que no haya dudas:

Configuración Eclipse DocflexLas instrucciones las he seguido íntegramente desde la página oficial, aunque como ya digo he tenido que modificar algunas pequeñas cosas debido a  errores, aún así si queréis echarle un vistazo: http://www.filigris.com/products/docflex_javadoc/doc.php#eclipse

Un saludo y espero que sea de ayuda.

Anuncios

Acerca de dafero

Mi nombre es Daniel Fernández, Graduado en Ingeniería Informática. En el caso de querer ponerse en contacto conmigo podéis hacerlo a través de al dirección: daferoES en Gmail.com o a través de Twitter https://twitter.com/dafero
Esta entrada fue publicada en Programación y etiquetada , , . Guarda el enlace permanente.

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s