Hello Dion, We discussed a little bit on the thread " Javadoc Plugin Change - What is better ?"
I know that it was better if we can keep it but actually I (we?) have no solution to do something clean. The use of a fileset creates a lot of problems (MJAVADOC16, MPJAVADOC-28, MPJAVADOC-29) that we can fix even if we add a lot of tests to use a fileset only when needed. I think that it is better actually to not implement the functionality and to not create a lot of problems for users. If someone find a solution to use the javadoc with a fileset which doesn't break the "standard" functionalities, he's the welcome. Arnaud > -----Message d'origine----- > De : Dion Gillard [mailto:[EMAIL PROTECTED] > Envoyé : jeudi 8 juillet 2004 02:32 > À : Maven Developers List > Objet : Re: cvs commit: maven-plugins/javadoc/xdocs changes.xml goals.xml index.xml > navigation.xml > properties.xml > > Was there any discussion of removing this functionality? > > I know I would have preferred another way around this. > > On 7 Jul 2004 21:21:45 -0000, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote: > > aheritier 2004/07/07 14:21:45 > > > > Modified: javadoc plugin.jelly > > javadoc/src/plugin-test maven.xml project.xml > > javadoc/src/plugin-test/src/main/org/apache/maven > > package.html > > javadoc/src/plugin-test/src/main/org/apache/maven2 > > package.html > > javadoc/src/plugin-test/src/opt/org/apache/maven3 > > package.html > > javadoc/xdocs changes.xml goals.xml index.xml navigation.xml > > properties.xml > > Log: > > Remove sourceModifications management in the plugin. > > It created a lot of problems (MPJAVADOC-28, MPJAVADOC-29). > > > > Revision Changes Path > > 1.47 +9 -81 maven-plugins/javadoc/plugin.jelly > > > > Index: plugin.jelly > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/plugin.jelly,v > > retrieving revision 1.46 > > retrieving revision 1.47 > > diff -u -r1.46 -r1.47 > > --- plugin.jelly 7 Jul 2004 10:00:15 -0000 1.46 > > +++ plugin.jelly 7 Jul 2004 21:21:45 -0000 1.47 > > @@ -36,7 +36,6 @@ > > <!-- internal variables --> > > <j:set var="internal.javadoc.jar" > value="${maven.build.dir}/${maven.final.name}_javadoc.jar"/> > > <j:set var="internal.javadoc.needed" value="null"/> > > - <j:set var="internal.javadoc.src.modifs" value="false"/> > > <j:set var="internal.javadoc.src.set" > value="${context.getAntProject().getReferences().get('maven.compile.src.set')}"/> > > <j:set var="internal.javadoc.working.dir" > > value="${maven.build.dir}/javadoc"/> > > > > @@ -75,7 +74,6 @@ > > ================================== > > internal.javadoc.jar = [${internal.javadoc.jar}] > > internal.javadoc.needed = [${internal.javadoc.needed}] > > -internal.javadoc.src.modifs = [${internal.javadoc.src.modifs}] > > internal.javadoc.src.set = [${internal.javadoc.src.set}] > > internal.javadoc.working.dir = [${internal.javadoc.working.dir}] > > </ant:echo> > > @@ -99,61 +97,29 @@ > > > > <j:when test="${internal.javadoc.needed != null}"> > > <!-- We have already decided if javadoc is needed --> > > - <j:if > > test="${maven.javadoc.debug}"><ant:echo>${internal.javadoc.needed} not > null</ant:echo></j:if> > > + <j:if test="${maven.javadoc.debug}"><ant:echo>internal.javadoc.needed > > not null : > ${internal.javadoc.needed}</ant:echo></j:if> > > </j:when> > > > > - <j:otherwise> > > - <!-- Create a patternset for source modifications --> > > - <patternset id="source.modifications"> > > - <ant:include name="**/*.java"/> > > - <!-- handle source modifications --> > > - <j:forEach var="sm" items="${pom.build.sourceModifications}"> > > - <ant:available property="classPresent" > > classname="${sm.className}"/> > > - <j:if test="${classPresent != 'true'}"> > > - <j:forEach var="exclude" items="${sm.excludes}"> > > - <ant:exclude name="${exclude}"/> > > - </j:forEach> <!-- end sourceModification exclude --> > > - <j:forEach var="include" items="${sm.includes}"> > > - <ant:include name="${include}"/> > > - </j:forEach> <!-- end sourceModification include --> > > - </j:if> > > - </j:forEach> <!-- end sourceModification --> > > - </patternset> > > - > > - <!-- test if sourceModifications are defined --> > > - <j:if test="${pom.build.sourceModifications != null && > !pom.build.sourceModifications.isEmpty()}"> > > - <j:set var="internal.javadoc.src.modifs" scope="parent" > > value="true"/> > > - </j:if> > > - > > - <j:if test="${maven.javadoc.debug}"> > > - <ant:echo>internal.javadoc.src.modifs is > > ${internal.javadoc.src.modifs}</ant:echo> > > - </j:if> > > + <j:otherwise> > > > > <!-- Tokenize the set of directories --> > > <util:tokenize var="sources.dirs" > delim="${path.separator}">${internal.javadoc.src.set}</util:tokenize> > > - > > - <!-- Counter used to name filesets --> > > - <j:set var="src.set.counter" value="0"/> > > - > > + > > <!-- For each directory --> > > <j:forEach var="dir" items="${sources.dirs}"> > > <!-- If we have not already find sources --> > > <j:if test="${internal.javadoc.needed != true}"> > > <!-- We construct the fileset --> > > - <ant:fileset id="${src.set.counter}" dir="${dir}"> > > - <patternset refid="source.modifications"/> > > - </ant:fileset> > > > > <ant:fileScanner var="sources"> > > - <ant:fileset refid="${src.set.counter}" /> > > + <ant:fileset dir="${dir}" include="**/*.java"/> > > </ant:fileScanner> > > > > <j:set var="internal.javadoc.needed" scope="parent" > > value="${sources.iterator().hasNext()}" /> > > > > - <j:set var="src.set.counter" value="${src.set.counter + 1}"/> > > </j:if> > > - </j:forEach> <!-- dir in maven.compile.src.set --> > > + </j:forEach> <!-- dir in internal.javadoc.src.set --> > > > > </j:otherwise> > > </j:choose> > > @@ -272,31 +238,9 @@ > > verbose="${maven.javadoc.debug}" > > > > > > > - <j:if test="${internal.javadoc.src.modifs == true}"> > > - <j:if test="${maven.javadoc.debug}"> > > - <ant:echo>Javadoc uses a fileset</ant:echo> > > - </j:if> > > - <!-- Tokenize the set of directories --> > > - <util:tokenize var="sources.dirs" > delim="${path.separator}">${internal.javadoc.src.set}</util:tokenize> > > - > > - <j:forEach var="dir" items="${sources.dirs}"> > > - > > - <echo>[${dir}] added to javadoc sources</echo> > > - <ant:fileset dir="${dir}"> > > - <patternset refid="source.modifications"/> > > - </ant:fileset> > > - > > - </j:forEach> <!-- dir in maven.compile.src.set --> > > - </j:if> > > - > > - <j:if test="${internal.javadoc.src.modifs != true}"> > > - <j:if test="${maven.javadoc.debug}"> > > - <ant:echo>Javadoc uses a source path</ant:echo> > > - </j:if> > > - <ant:sourcepath> > > - <ant:path refid="maven.compile.src.set"/> > > - </ant:sourcepath> > > - </j:if> > > + <ant:sourcepath> > > + <ant:path refid="maven.compile.src.set"/> > > + </ant:sourcepath> > > > > <j:if test="${context.getVariable('maven.javadoc.source') != null}"> > > <ant:setProperty name="source" value="${maven.javadoc.source}" /> > > @@ -421,22 +365,6 @@ > > inputText="${inputText}" > > output="${genDocs}/javadoc.xml"/> > > > > - <j:if test="${internal.javadoc.src.modifs}"> > > - <!-- > > - Because we use in the javadoc task a fileset and not a packageset > > - (to allow sourceModifications) the javadoc doesn't copy > > - automatically doc-files directories. > > - We must do it manually. > > - --> > > - <util:tokenize var="sources.dirs" > delim="${path.separator}">${internal.javadoc.src.set}</util:tokenize> > > - <ant:copy todir="${maven.javadoc.destdir}"> > > - <j:forEach var="dir" items="${sources.dirs}"> > > - <ant:fileset dir="${dir}"> > > - <ant:include name="**/doc-files/**/*"/> > > - </ant:fileset> > > - </j:forEach> > > - </ant:copy> > > - </j:if> > > </j:if> > > > > <j:if test="not ${internal.javadoc.needed}"> > > @@ -525,4 +453,4 @@ > > <goal name="javadoc:generate" prereqs="maven-javadoc-plugin:report"/> > > <goal name="javadoc" prereqs="maven-javadoc-plugin:report"/> > > > > -</project> > > +</project> > > \ No newline at end of file > > > > 1.9 +6 -5 maven-plugins/javadoc/src/plugin-test/maven.xml > > > > Index: maven.xml > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/src/plugin-test/maven.xml,v > > retrieving revision 1.8 > > retrieving revision 1.9 > > diff -u -r1.8 -r1.9 > > --- maven.xml 26 May 2004 12:38:27 -0000 1.8 > > +++ maven.xml 7 Jul 2004 21:21:45 -0000 1.9 > > @@ -34,10 +34,10 @@ > > <!-- assert that doc-files are copied - Issue MPJAVADOC-24 --> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven/doc- > files/example.txt"/> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven2/doc- > files/example.txt"/> > > - <!-- assert that javadoc for classes Dummy, Dummy2, Dummy3 are generated --> > > + <!-- assert that javadoc for classes Dummy, Dummy2, Dummy3, Dummy4 are > > generated --> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven/Dummy.html"/> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven/Dummy2.html"/> > > - <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven2/Dummy3.html"/> > > + <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven2/Dummy4.html"/> > > </goal> > > > > <goal name="test-javadoc-multi-src"> > > @@ -52,17 +52,18 @@ > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven/doc- > files/example.txt"/> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven2/doc- > files/example.txt"/> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven3/doc- > files/example.txt"/> > > - <!-- assert that javadoc for classes Dummy, Dummy2, Dummy3, Dummy5, Dummy6 > > are generated - > -> > > + <!-- assert that javadoc for classes Dummy, Dummy2, Dummy3, Dummy4, Dummy5, > > Dummy6 are > generated --> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven/Dummy.html"/> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven/Dummy2.html"/> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven2/Dummy3.html"/> > > + <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven2/Dummy4.html"/> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven3/Dummy5.html"/> > > <assert:assertFileExists > > file="${maven.javadoc.destdir}/org/apache/maven3/Dummy6.html"/> > > </goal> > > > > <goal name="test-javadoc-jar"> > > - <delete file="${maven.build.dir}/${maven.final.name}_javadoc.jar" > > failonerror="false"/> > > + <delete file="${maven.build.dir}/${maven.final.name}_javadoc.jar" > > failonerror="false"/> > > <attainGoal name="javadoc:jar"/> > > <assert:assertFileExists > > file="${maven.build.dir}/${maven.final.name}_javadoc.jar"/> > > </goal> > > -</project> > > +</project> > > \ No newline at end of file > > > > 1.4 +1 -9 maven-plugins/javadoc/src/plugin-test/project.xml > > > > Index: project.xml > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/src/plugin-test/project.xml,v > > retrieving revision 1.3 > > retrieving revision 1.4 > > diff -u -r1.3 -r1.4 > > --- project.xml 23 May 2004 22:05:00 -0000 1.3 > > +++ project.xml 7 Jul 2004 21:21:45 -0000 1.4 > > @@ -54,13 +54,5 @@ > > > > <build> > > <sourceDirectory>src/main</sourceDirectory> > > - <sourceModifications> > > - <sourceModification> > > - <className>org.apache.maven.Dummy</className> > > - <excludes> > > - <exclude>**/Dummy4.*</exclude> > > - </excludes> > > - </sourceModification> > > - </sourceModifications> > > </build> > > -</project> > > +</project> > > \ No newline at end of file > > > > 1.3 +4 -1 maven-plugins/javadoc/src/plugin- > test/src/main/org/apache/maven/package.html > > > > Index: package.html > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/src/plugin- > test/src/main/org/apache/maven/package.html,v > > retrieving revision 1.2 > > retrieving revision 1.3 > > diff -u -r1.2 -r1.3 > > --- package.html 19 May 2004 23:20:33 -0000 1.2 > > +++ package.html 7 Jul 2004 21:21:45 -0000 1.3 > > @@ -1,4 +1,7 @@ > > <html> > > <head></head> > > -<body>Package documentation.<br/> <a href="doc-files/example.txt">example.txt > > in doc-files > directory.</a></body> > > +<body> > > +Package documentation. <br/> > > +<a href="doc-files/example.txt">example.txt</a> in doc-files directory. > > +</body> > > </html> > > > > 1.2 +4 -1 maven-plugins/javadoc/src/plugin- > test/src/main/org/apache/maven2/package.html > > > > Index: package.html > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/src/plugin- > test/src/main/org/apache/maven2/package.html,v > > retrieving revision 1.1 > > retrieving revision 1.2 > > diff -u -r1.1 -r1.2 > > --- package.html 19 May 2004 23:20:34 -0000 1.1 > > +++ package.html 7 Jul 2004 21:21:45 -0000 1.2 > > @@ -1,4 +1,7 @@ > > <html> > > <head></head> > > -<body>Package documentation.<br/> <a href="doc-files/example.txt">example.txt > > in doc-files > directory.</a></body> > > +<body> > > +Package documentation. <br/> > > +<a href="doc-files/example.txt">example.txt</a> in doc-files directory. > > +</body> > > </html> > > > > 1.2 +4 -1 maven-plugins/javadoc/src/plugin- > test/src/opt/org/apache/maven3/package.html > > > > Index: package.html > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/src/plugin- > test/src/opt/org/apache/maven3/package.html,v > > retrieving revision 1.1 > > retrieving revision 1.2 > > diff -u -r1.1 -r1.2 > > --- package.html 21 May 2004 23:44:09 -0000 1.1 > > +++ package.html 7 Jul 2004 21:21:45 -0000 1.2 > > @@ -1,4 +1,7 @@ > > <html> > > <head></head> > > -<body>Package documentation.<br/> <a href="doc-files/example.txt">example.txt > > in doc-files > directory.</a></body> > > +<body> > > +Package documentation. <br/> > > +<a href="doc-files/example.txt">example.txt</a> in doc-files directory. > > +</body> > > </html> > > > > 1.34 +1 -1 maven-plugins/javadoc/xdocs/changes.xml > > > > Index: changes.xml > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/xdocs/changes.xml,v > > retrieving revision 1.33 > > retrieving revision 1.34 > > diff -u -r1.33 -r1.34 > > --- changes.xml 28 Jun 2004 23:14:24 -0000 1.33 > > +++ changes.xml 7 Jul 2004 21:21:45 -0000 1.34 > > @@ -29,7 +29,7 @@ > > <action dev="aheritier" type="add">Add the property maven.javadoc.debug > > to print > informations to debug the plugin.</action> > > <action dev="aheritier" type="fix" issue="MPJAVADOC-26" due-to="Denis > > McLaughlin">Fix > the needed flag when there's an empty sources directory.</action> > > <action dev="aheritier" type="fix" issue="MPJAVADOC-24">doc-files > > directories contents > are correctly copied.</action> > > - <action dev="brett" type="fix" issue="MPJAVADOC-5">Add support for > > multiple source > directories.</action> > > + <action dev="brett" type="fix" issue="MPJAVADOC-5">Add support for > > multiple source > directories. SourceModifications aren't supported !!!</action> > > </release> > > <release version="1.5" date="2004-05-15"> > > <action dev="dion" type="fix">javadoc:jar changed to place the jar in > maven.build.dir</action> > > > > 1.4 +1 -1 maven-plugins/javadoc/xdocs/goals.xml > > > > Index: goals.xml > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/xdocs/goals.xml,v > > retrieving revision 1.3 > > retrieving revision 1.4 > > diff -u -r1.3 -r1.4 > > --- goals.xml 4 Mar 2004 18:35:59 -0000 1.3 > > +++ goals.xml 7 Jul 2004 21:21:45 -0000 1.4 > > @@ -59,4 +59,4 @@ > > </goal> > > </goals> > > </body> > > -</document> > > +</document> > > \ No newline at end of file > > > > 1.4 +1 -1 maven-plugins/javadoc/xdocs/index.xml > > > > Index: index.xml > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/xdocs/index.xml,v > > retrieving revision 1.3 > > retrieving revision 1.4 > > diff -u -r1.3 -r1.4 > > --- index.xml 4 Mar 2004 18:35:59 -0000 1.3 > > +++ index.xml 7 Jul 2004 21:21:45 -0000 1.4 > > @@ -44,4 +44,4 @@ > > </p> > > </section> > > </body> > > -</document> > > +</document> > > \ No newline at end of file > > > > 1.4 +1 -1 maven-plugins/javadoc/xdocs/navigation.xml > > > > Index: navigation.xml > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/xdocs/navigation.xml,v > > retrieving revision 1.3 > > retrieving revision 1.4 > > diff -u -r1.3 -r1.4 > > --- navigation.xml 4 Mar 2004 18:35:59 -0000 1.3 > > +++ navigation.xml 7 Jul 2004 21:21:45 -0000 1.4 > > @@ -31,4 +31,4 @@ > > <item name="Properties" href="/properties.html" /> > > </menu> > > </body> > > -</project> > > +</project> > > \ No newline at end of file > > > > 1.16 +1 -1 maven-plugins/javadoc/xdocs/properties.xml > > > > Index: properties.xml > > =================================================================== > > RCS file: /home/cvs/maven-plugins/javadoc/xdocs/properties.xml,v > > retrieving revision 1.15 > > retrieving revision 1.16 > > diff -u -r1.15 -r1.16 > > --- properties.xml 28 Jun 2004 23:14:24 -0000 1.15 > > +++ properties.xml 7 Jul 2004 21:21:45 -0000 1.16 > > @@ -307,4 +307,4 @@ > > </table> > > </section> > > </body> > > -</document> > > +</document> > > \ No newline at end of file > > > > --------------------------------------------------------------------- > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > For additional commands, e-mail: [EMAIL PROTECTED] > > > > > > > -- > http://www.multitask.com.au/people/dion/ > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
