2011-06-28 15 views
9

Tengo una aplicación Java que consta de varios módulos. Me gustaría generar Javadoc para todos ellos juntos: es decir, a partir de estos varios módulos, me gustaría una sola colección de archivos HTML con un solo index.html, un solo allclasses-frame.html etc. y los diversos hipervínculos deberían funcionar a través de módulos.Combinar Javadoc para varios módulos en una sola colección

Uso Maven, pero no estoy necesariamente limitado a las soluciones específicas de Maven. Esto será realizado por un trabajo cron para que también se puedan usar otras herramientas.

¿Cuál es la forma más directa de autogenerar Javadoc en este caso?

+0

¿Esto sigue abierto? Si es así, por favor comente las respuestas que dicen que no ayudan. En caso negativo, acepte la mejor respuesta (o agregue una respuesta propia, si ninguna respuesta es lo suficientemente buena, y descubrió cómo funciona). –

Respuesta

3

Si puede administrarlo, javadoc puede generar la documentación combinada siempre que combine las fuentes de entrada. Tal vez hay una solución más elegante; pero, ¿por qué no copiar todas las fuentes en un árbol combinado y luego ejecutar javadoc?

La otra opción es utilizar la opción -link y hacer que la documentación de un sitio haga referencia a la documentación de otro sitio. Tenga en cuenta que si elige esta opción, también puede consultar la opción linkoffline para obtener flexibilidad en sus compilaciones javadoc (a menos que pueda implementar la documentación en los servidores web en el orden correcto antes de que las compilaciones posteriores lo necesiten).

+0

+1 - simplemente configure sourcepath (y los paquetes) para incluir todo lo que desea documentar. –

1

Si está utilizando eclipse IDE, existe la opción de generar javadocs para su proyecto en el menú del proyecto. Para obtener más información, consulte este link

+0

lo mismo se aplica en NetBeans IDE también. – Rakesh

Cuestiones relacionadas