[M2] Javadoc et classes de test

**dvicente72** · 04/04/2007, 14h01

Salut à tous,

j'ai un projet multi-modules et je génére la javadoc pour l'ensemble du projet.

ça fonctionne bien.

Maintenant, j'aimerai rajouter la javadoc (toujours en aggregation) sur les classes de test.

Comment faire ?

- soit pour l'inclure dans la javadoc existante
- soit avec un menuitem différent (donc 2 liens javadoc)

j'ai bien essayé de faire ça :

Code :

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
<reporting>
.....
<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.1</version>
        <configuration>
					<!--<links>
            <link>http://java.sun.com/j2se/1.4.2/docs/api</link>
            <link>http://logging.apache.org/log4j/docs/api</link>
            <link>http://java.sun.com/j2ee/1.4/docs/api</link>
            <link>http://www.junit.org/junit/javadoc/</link>
          </links>-->
          <aggregate>true</aggregate>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.1</version>
        <configuration>
					<debug>true</debug>
					<reportOutputDirectory>${project.reporting.outputDirectory}/test-apidocs</reportOutputDirectory>
					<sourcepath>${basedir}/src/test</sourcepath>
					<verbose>true</verbose>
          <aggregate>true</aggregate>
        </configuration>
      </plugin>
....
</reporting>

en utilisant le sourcepath mais ça ne fonctionne pas.

Quelqu'un a une idée ?

merci d'avance pour votre aide

**dvicente72** · 15/05/2007, 16h11

j'ai enfin trouvé, donc si ça peut servir à quelqu'un :

il faut d'abord mettre un site.xml dans ${project.basedir}/src/site avec dedans :

Code :

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
<?xml version="1.0" encoding="${outputEncoding}"?>
<project name="${project.name}">
  <bannerLeft>
    <name>${project.name}</name>
  </bannerLeft>
  <body>
    <links>
      <item name="${project.name}" href="${project.url}"/>
    </links>
    <menu ref="parent" />
    <menu ref="modules" />
    <menu ref="reports" />
    <menu name="Test JavaDocs">
    	<item name="Test JavaDocs" href="test-apidocs/index.html" />
    </menu>
  </body>
</project>

ensuite il faut utiliser le javadoc via antrun durant la phase site comme suit (c'est le seul moyen élégant et j'en essayé des idées

):

Code :

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
<build>
  	<plugins>
  		<plugin>
      	<groupId>org.apache.maven.plugins</groupId>
						<artifactId>maven-antrun-plugin</artifactId>
						<dependencies>
          <dependency>
		        <groupId>junit</groupId>
		        <artifactId>junit</artifactId>
		        <version>3.8.1</version>
		     </dependency>
        </dependencies>
						<executions>
							<execution>
								<id>generateTestsJavadoc</id>
								<phase>site</phase>
								<configuration>
									<tasks>
										<echo>generate Tests Javadoc</echo>
										<javadoc
									           destdir="${project.reporting.outputDirectory}/test-apidocs"
									           author="true"
									           version="true"
									           use="true"
									           failonerror="false"
									           classpathref="maven.compile.classpath"
									           windowtitle="${project.name} Tests API">						
									    <fileset dir="${project.basedir}/src/test/java" defaultexcludes="yes"/>
    																		    <doctitle><![CDATA[<h1>${project.name} Tests Javadoc</h1>]]></doctitle>
									  </javadoc>
									</tasks>
								</configuration>
								<goals>
									<goal>run</goal>
								</goals>
							</execution>
						</executions>
      </plugin>
  	</plugins>
  </build>

et voilà, c'est tout beau quand on fait un mvn site

**Palmer** · 15/05/2007, 16h32

Afin de comprendre ton problème et ta solution:
Si j'ai bien compris, tu as opté pour la deuxièmme solution ?

**dvicente72** · 15/05/2007, 20h41

non il n'y a pas 2 solutions, le tout est la solution.

je créé un site.xml pour pouvoir rajouter un menu sur le site comme cela:

Code :

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

1
2
3
4
 
<menu name="Test JavaDocs">
    	<item name="Test JavaDocs" href="test-apidocs/index.html" />
    </menu>

et ensuite tu rajoutes la partie "build" afin de générer la javadoc à l'endroit prévu lors du mvn site

car la partie build seule ne generera que la javadoc mais tu n'auras aucun lien dans le site pour y acceder d'ou le besoin d'un site.xml customisé

et le tout te donne la javadoc de tes tests unitaires à partir de l'item de menu "Test JavaDocs"

j'espere avoir été clair

[M2] Javadoc et classes de test

Maven Java

Discussions similaires

Partager

Partager