2010-03-28 7 views
2

Je voudrais créer des documents HTML pour une bibliothèque de classes Java qui comprendJava: Comment créer des documents de classe attrayants avec Javadoc?

    informations guide de programmation
  • - au-delà d'un des exemples de code référence de classe
  • dans la doc de référence
  • régions pliables

Je veux qu'il soit bien stylé. Quelque chose comme ceci:

alt text http://i40.tinypic.com/25qqjbq.jpg

Je pense que Javadoc expose une API doclet qui permet aux autres parties de fournir la génération de doc intégré dans Javadoc. Y at-il une option doclet que je peux utiliser (gratuitement) qui fait quelque chose d'un peu plus agréable que la sortie javadoc standard?

J'ai essayé de googler pour cela mais pas de chance. Suggestions?

Addendum
Je trouve doclet.com, mais je ne sais pas comment évaluer les options. Recommandations? En particulier, XHtmlDoclet semble vouloir résoudre ces problèmes. Quelqu'un l'a utilisé? I can't get it to work. Aussi le example offered by the XHTML Doclet guys ne semble pas mieux que the docs generated from c.1998 javadoc.


connexes:
Why does Javadoc generate non-compliant XHTML?

Répondre

1

Cette question m'a fait réfléchir (ok, googling) et je suis tombé sur this set of taglets. Je n'ai jamais essayé, mais ça a l'air plutôt prometteur.

1

Peut-être que vous pensez de l'API Java doclet:

http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html

Il semble que vous ajoutez des exemples et un texte. Je pense que c'est tout à fait possible avec les javadocs existants. Le problème sera le contenu plutôt que le rendu.

Castor utilisé doclet pour alléger sa charge de configuration. Il en a été de même pour EJB 1.0. Jetez un oeil à ceux si vous le souhaitez.

+0

Changer le CSS devrait être trivial aussi. –

+0

@dummymo: Eh bien l'API doclet permet des moteurs de doclet supplémentaires autant que je sache. En d'autres termes, la génération est connectable. Je demande, quels autres documents ont été produits pour générer des documents d'API et d'orientation? @donal, ok, semble facile. Comment? – Cheeso

+0

Vous avez les fichiers de sortie, et javadoc utilise un seul fichier CSS dans le répertoire racine de l'arborescence générée. Si vous ne pouvez pas travailler à partir de là, je désespère ... ;-) –

Questions connexes