Salut,
Je ne trouve pas où je dois écrire la description de mon package pour qu'elle apparaisse dans la javadoc (dans "overview")...
Merci d'avance
Lilian
Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter
[ Javadoc ] Documenter un package
Salut,
Je ne trouve pas où je dois écrire la description de mon package pour qu'elle apparaisse dans la javadoc (dans "overview")...
Merci d'avance
Lilian
Dans le répertoire correspondant à ton package (où se trouve tes fichier source java), crée un fichier nommé package.html. Dans ce fichier tu pourras décrire ton package, tout ce qui est entre <body> et </body> est extrait par javadoc. Comme pour les classes, les méthodes et les variables publiques, la première phrase doit constituer un résumé (c'est ce qui sera affiché dans overview, le reste apparaît quand tu clique sur le lien du package).
Tu peux également décrire ton API globale en créant à la racine de tous tes packages un fichier appelé overview.html (même règle que pour package.html, tout ce qui est entre <body et </body> est extrait). La première phrase s'affiche au dessus de la description des packages, la description globale s'affichera en dessous.
Ca marche, merci beaucoup
Mais de rien! 8)
Répondre avec citation
Partager