Discussion :

[slyveuth]

Bonjour,
Je dois générer une javadoc limité à certains packages et surtout certaines classes uniquement.
J'ai un projet composé de différents modules, et je dois générer une javadoc globale ne comprenant que quelques packages de certains modules et uniquemement certaines classes d'un module. J'ai cherché sur le site du plugin maven-javadoc , tous les exemples proposés ne permettent que la limitation en terme de packages. Je ne vois aucun paramètre pour donner des noms de classes.

Je decris brièvement la structure du projet

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
 
Project
|-- pom.xml
|-- Module1
|   -- package1
|   -- package2
|      --classe1
|      --classe2 
|      -- subpackage1
|   -- pom.xml
|-- Module2
|   -- package1
|   `-- pom.xml

en gros je voudrais générer une javadoc contenant la classe 1 du module 1 et le package 1 du module 2

pour le moment je n'arrive qu'à filtrer d'un point de vue package

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
 
<configuration>
  <subpackages>package1</subpackages>
  <excludePackageNames>package1.subpackage</excludePackageNames>
</configuration>

Mais comment faire pour filtrer sur les classes???

D'avance merci

[romaintaz]

Je crois que ce n'est pas possible de faire ce que tu veux.
Si je ne dis pas de bêtise, l'outil Javadoc ne permet que d'exclure des packages et non des classes. Cette option avait été introduite dans Javadoc 1.4.2, et rien visiblement n'a été ajouté dans le Javadoc 5.0...
Par conséquent, le plugin javadoc de Maven ne permet que l'exclusion de packages...

[slyveuth]

Bon j'ai finalement trouvé une solution au problème, on peut ajouter des classes via le paramètre <additionalparam> qui m'était passé sous le nez jusque là :-)

En fait dans mon cas, si je veux qu'une seule classe du subpackage 1 du module 1 soit dans la doc , ca donnera

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
 
<configuration>
  <subpackages>package1</subpackages>
  <excludePackageNames>package1.subpackage</excludePackageNames>
 <additionalparam>{fullpathModule1}/package1/subpackage1/classe1.java</additionalparam>
</configuration>

Bon je sais que c'est pas super, de mettre le full path, mais bon c'est une limitation de l'outil javadoc ...
Si jamais d'autres ont le même besoin, voilà ue possibilité.

[romaintaz]

Ok, c'est bon à savoir (même si ce besoin est quand même peu fréquent ).

Une petite question : La Javadoc produite est elle tout à fait correcte ? Je veux dire par là, est-ce que les liens entre les packages et la classe ajoutée sont corrects ? Les liens vers les usages de cette classe aussi ?

[slyveuth]

oui oui oui ca marche bien , tous les liens qui peuvent exister (entre les fichiers présents uniquement!!) fonctionnent. Pour les classes référencées non présentes dans la javadoc, ben l'outil javadoc met des warnings à la génération et n'ajoute pas de link dans les fichiers.
Mais sinon pour la doc, c'est propre :-)

Et oui j'avoue que mon cas est un peu tiré par les cheuveux mais bon c'est le client qui décide :-)