You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by Grant Ingersoll <gs...@apache.org> on 2006/12/12 15:10:35 UTC

Javadocs Issues

Can anyone recreate this:

With JDK 1.4:
I run ant javadocs and I get no output whatsoever in build/docs/api

It says 3 errors and 3 warnings.  Using verbose=true doesn't show  
anything.  Adding failonerror=true causes Build Failed, but it  
doesn't give a reason.  It seems like it gets through file parsing  
and then just stops.

With 1.5
Same thing, everything builds fine.

It says 11 errors and 333 warnings

----

The only messages (in 1.4) I get are (and I think they are a red  
herring):

   [javadoc] .../projects/lucene/Lucene-Trunk/src/java/org/apache/ 
lucene/search/spans/NearSpansOrdered.java:163: warning: as of release  
1.4, assert is a keyword, and may not be used as an identifier
   [javadoc]       assert (subSpansByDoc[i].doc() == maxDoc)
   [javadoc]       ^
   [javadoc] .../projects/lucene/Lucene-Trunk/src/java/org/apache/ 
lucene/search/spans/NearSpansOrdered.java:164: ';' expected
   [javadoc]              : " NearSpansOrdered.toSameDoc() spans " +  
subSpansByDoc[0]
   [javadoc]              ^
   [javadoc] .../projects/lucene/Lucene-Trunk/src/java/org/apache/ 
lucene/search/spans/NearSpansOrdered.java:180: warning: as of release  
1.4, assert is a keyword, and may not be used as an identifier
   [javadoc]     assert spans1.doc() == spans2.doc() : "doc1 " +  
spans1.doc() + " != doc2 " + spans2.doc();
   [javadoc]     ^
   [javadoc] .../projects/lucene/Lucene-Trunk/src/java/org/apache/ 
lucene/search/spans/NearSpansOrdered.java:180: ';' expected
   [javadoc]     assert spans1.doc() == spans2.doc() : "doc1 " +  
spans1.doc() + " != doc2 " + spans2.doc();
   [javadoc]                  ^
   [javadoc] .../projects/lucene/Lucene-Trunk/src/java/org/apache/ 
lucene/search/spans/NearSpansOrdered.java:247: warning: as of release  
1.4, assert is a keyword, and may not be used as an identifier
   [javadoc]       assert prevStart <= matchStart;
   [javadoc]       ^
   [javadoc] .../projects/lucene/Lucene-Trunk/src/java/org/apache/ 
lucene/search/spans/NearSpansOrdered.java:247: ';' expected
   [javadoc]       assert prevStart <= matchStart;
   [javadoc]                        ^
   [javadoc] Loading source files for package org.apache.lucene.store...

   Adding ant -v gets:
BUILD FAILED
/tmp/lucene-nightly-gsi/build.xml:126: The following error occurred  
while executing this line:
/tmp/lucene-nightly-gsi/build.xml:363: Javadoc returned 1
         at  
org.apache.tools.ant.ProjectHelper.addLocationToBuildException 
(ProjectHelper.java:539)
         at org.apache.tools.ant.taskdefs.MacroInstance.execute 
(MacroInstance.java:380)
         at org.apache.tools.ant.UnknownElement.execute 
(UnknownElement.java:275)
         at org.apache.tools.ant.Task.perform(Task.java:364)
         at org.apache.tools.ant.Target.execute(Target.java:341)
         at org.apache.tools.ant.Target.performTasks(Target.java:369)
         at org.apache.tools.ant.Project.executeSortedTargets 
(Project.java:1216)
         at org.apache.tools.ant.Project.executeTarget(Project.java: 
1185)
         at org.apache.tools.ant.helper.DefaultExecutor.executeTargets 
(DefaultExecutor.java:40)
         at org.apache.tools.ant.Project.executeTargets(Project.java: 
1068)
         at org.apache.tools.ant.Main.runBuild(Main.java:668)
         at org.apache.tools.ant.Main.startAnt(Main.java:187)
         at org.apache.tools.ant.launch.Launcher.run(Launcher.java:246)
         at org.apache.tools.ant.launch.Launcher.main(Launcher.java:67)
Caused by: /tmp/lucene-nightly-gsi/build.xml:363: Javadoc returned 1
         at org.apache.tools.ant.taskdefs.Javadoc.execute 
(Javadoc.java:1954)
         at org.apache.tools.ant.UnknownElement.execute 
(UnknownElement.java:275)
         at org.apache.tools.ant.Task.perform(Task.java:364)
         at org.apache.tools.ant.taskdefs.Sequential.execute 
(Sequential.java:64)
         at org.apache.tools.ant.UnknownElement.execute 
(UnknownElement.java:275)
         at org.apache.tools.ant.Task.perform(Task.java:364)
         at org.apache.tools.ant.taskdefs.MacroInstance.execute 
(MacroInstance.java:378)
         ... 12 more
--- Nested Exception ---
/tmp/lucene-nightly-gsi/build.xml:363: Javadoc returned 1
         at org.apache.tools.ant.taskdefs.Javadoc.execute 
(Javadoc.java:1954)
         at org.apache.tools.ant.UnknownElement.execute 
(UnknownElement.java:275)
         at org.apache.tools.ant.Task.perform(Task.java:364)
         at org.apache.tools.ant.taskdefs.Sequential.execute 
(Sequential.java:64)
         at org.apache.tools.ant.UnknownElement.execute 
(UnknownElement.java:275)
         at org.apache.tools.ant.Task.perform(Task.java:364)
         at org.apache.tools.ant.taskdefs.MacroInstance.execute 
(MacroInstance.java:378)
         at org.apache.tools.ant.UnknownElement.execute 
(UnknownElement.java:275)
         at org.apache.tools.ant.Task.perform(Task.java:364)
         at org.apache.tools.ant.Target.execute(Target.java:341)
         at org.apache.tools.ant.Target.performTasks(Target.java:369)
         at org.apache.tools.ant.Project.executeSortedTargets 
(Project.java:1216)
         at org.apache.tools.ant.Project.executeTarget(Project.java: 
1185)
         at org.apache.tools.ant.helper.DefaultExecutor.executeTargets 
(DefaultExecutor.java:40)
         at org.apache.tools.ant.Project.executeTargets(Project.java: 
1068)
         at org.apache.tools.ant.Main.runBuild(Main.java:668)
         at org.apache.tools.ant.Main.startAnt(Main.java:187)
         at org.apache.tools.ant.launch.Launcher.run(Launcher.java:246)
         at org.apache.tools.ant.launch.Launcher.main(Launcher.java:67)



I have tried this on OS X and Solaris 10 (lucene.zones.apache.org)  
with the same results.

Ant version is 1.6.5.

--------------------------
Grant Ingersoll
Center for Natural Language Processing
http://www.cnlp.org

Read the Lucene Java FAQ at http://wiki.apache.org/jakarta-lucene/ 
LuceneFAQ



---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Re: Javadocs Issues

Posted by Grant Ingersoll <gs...@apache.org>.
yep, that works.  I will commit the change.

On Dec 12, 2006, at 2:50 PM, Chris Hostetter wrote:

>
> : OK, if I put in source="1.4"  then it works, but is that going to
> : break the GData stuff?
>
> try adding this to the javadoc task...
>
>           source="${ant.java.version}"
>
> ...the gdata stuff is automatically skiped when the java version  
> running
> ant isn't 1.5, and with that option the javadocs seem to build fine  
> for me
> regardless of wether i'm using 1.4 or 1.5.
>
>
>
> -Hoss
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: java-dev-help@lucene.apache.org
>

--------------------------
Grant Ingersoll
Center for Natural Language Processing
http://www.cnlp.org

Read the Lucene Java FAQ at http://wiki.apache.org/jakarta-lucene/ 
LuceneFAQ



---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Re: Javadocs Issues

Posted by Chris Hostetter <ho...@fucit.org>.
: The the "bad" java doc will be removed soon as I almost finished the
: Gdata Object Model which means the google client classes are not

The problems Grant was having actually had nothing to do with gdata ... it
was trggered by some core code that uses assertions -- something perfectly
valid in java1.4, but javadoc1.4 needs you to explicitly set the "source"
option to 1.4 or higher to prevent it from complaining.

we were just worried that if we hardcoded the source option to 1.4 gdata's
javadocs would never work at all.



-Hoss


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Re: Javadocs Issues

Posted by Simon Willnauer <si...@googlemail.com>.
Thanks hoss for the answer....

The the "bad" java doc will be removed soon as I almost finished the
Gdata Object Model which means the google client classes are not
needed anymore. I will change the structure of the gdata contrib
project tomorrow which will cause some commits. I will skip rhe
integration of the new classes  until next year as soon as I got back
from San Francisco.

best regards simon

On 12/12/06, Chris Hostetter <ho...@fucit.org> wrote:
>
> : OK, if I put in source="1.4"  then it works, but is that going to
> : break the GData stuff?
>
> try adding this to the javadoc task...
>
>           source="${ant.java.version}"
>
> ...the gdata stuff is automatically skiped when the java version running
> ant isn't 1.5, and with that option the javadocs seem to build fine for me
> regardless of wether i'm using 1.4 or 1.5.
>
>
>
> -Hoss
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: java-dev-help@lucene.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Re: Javadocs Issues

Posted by Chris Hostetter <ho...@fucit.org>.
: OK, if I put in source="1.4"  then it works, but is that going to
: break the GData stuff?

try adding this to the javadoc task...

          source="${ant.java.version}"

...the gdata stuff is automatically skiped when the java version running
ant isn't 1.5, and with that option the javadocs seem to build fine for me
regardless of wether i'm using 1.4 or 1.5.



-Hoss


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Re: Javadocs Issues

Posted by Grant Ingersoll <gs...@apache.org>.
OK, if I put in source="1.4"  then it works, but is that going to  
break the GData stuff?

On Dec 12, 2006, at 9:38 AM, Michael McCandless wrote:

> Grant Ingersoll wrote:
>> Can anyone recreate this:
>> With JDK 1.4:
>> I run ant javadocs and I get no output whatsoever in build/docs/api
>
> I see this as well, with Sun JDK 1.4.2 on Windows, ant 1.6.5.  If I  
> move
> that one source (src/java/org/apache/lucene/search/spans/ 
> NearSpansOrdered.java)
> out of the way then indeed the javadocs seem to build correctly!
>
> Mike
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: java-dev-help@lucene.apache.org
>

--------------------------
Grant Ingersoll
Center for Natural Language Processing
http://www.cnlp.org

Read the Lucene Java FAQ at http://wiki.apache.org/jakarta-lucene/ 
LuceneFAQ



---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Re: Javadocs Issues

Posted by Michael McCandless <lu...@mikemccandless.com>.
Grant Ingersoll wrote:
> Can anyone recreate this:
> 
> With JDK 1.4:
> I run ant javadocs and I get no output whatsoever in build/docs/api

I see this as well, with Sun JDK 1.4.2 on Windows, ant 1.6.5.  If I move
that one source 
(src/java/org/apache/lucene/search/spans/NearSpansOrdered.java)
out of the way then indeed the javadocs seem to build correctly!

Mike

---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org