You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@pdfbox.apache.org by Thad Humphries <th...@gmail.com> on 2016/06/22 19:58:57 UTC
Maven javadoc:javadoc errors with Java 8
When I tried to build the JavaDocs for PDFBox 2.1.0-SNAPSHOT (taken from
SVN yesterday) with Java 8, `mvn javadoc:javadoc` failed with numerous
errors. To correct this, I had to turn off the doclint by modifying
parent/pom.xml as follows:
$ svn diff parent/pom.xml
Index: parent/pom.xml
===================================================================
--- parent/pom.xml (revision 1749587)
+++ parent/pom.xml (working copy)
@@ -160,6 +160,7 @@
</links>
<encoding>UTF-8</encoding>
<notimestamp>true</notimestamp>
+ <additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
<plugin>
(Tip taken from
http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html)
--
"Hell hath no limits, nor is circumscrib'd In one self-place; but where we
are is hell, And where hell is, there must we ever be" --Christopher
Marlowe, *Doctor Faustus* (v. 121-24)
Re: Maven javadoc:javadoc errors with Java 8
Posted by Thad Humphries <th...@gmail.com>.
My apologies--it is working. I was deceived by the failure when I ran `mvn
javadoc:javadoc` without specifying the pdfbox project and all those
messages [ERROR]:
[INFO]
------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] PDFBox parent ...................................... SUCCESS [
0.403 s]
[INFO] Apache FontBox ..................................... SUCCESS [
5.661 s]
[INFO] Apache XmpBox ...................................... SUCCESS [
3.369 s]
[INFO] Apache PDFBox ...................................... FAILURE [
7.555 s]
[INFO] Apache Preflight ................................... SKIPPED
...
All those messages [ERROR] are confusing, too. But, yes,
pdfbox/target/site/apidocs is there. Thank you.
On Wed, Jun 29, 2016 at 4:45 PM, Tilman Hausherr <TH...@t-online.de>
wrote:
> But I did test with JDK8 and it worked, i.e. lots of warnings but no
> errors. I did fix a lot of problems like the one mentioned by that website.
>
> Do you have anything with "error:" (spelled exactly like that)?
>
> Do you have any other settings that result in warnings being considered to
> be [ERROR] ?
>
> Could you post the full output? Maybe there's one single error I forgot to
> fix.
>
> Tilman
>
> Am 29.06.2016 um 22:19 schrieb Thad Humphries:
>
>> If I set JAVA_HOME to JDK 7 and use that as my path, `mvn javadoc:javadoc
>> -pl pdfbox` runs with only a few warnings (see below). But if I run with
>> JDK 8,
>> there are many (lowercase) warning messages which result in [ERROR]s (as
>> you can see by the previous email. The blog I cited in my first message (
>> http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html)
>> lists a bunch of things that are required by JDK 8's doclint. JDK 8 made
>> *a
>> lot* of changes to doclint.
>>
>>
>>
>> [WARNING] Javadoc Warnings
>> [WARNING] warning: [options] bootstrap class path not set in conjunction
>> with -source 1.6
>> [WARNING]
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/StandardProtectionPolicy.java:120:
>> warning - @return tag has no arguments.
>> [WARNING]
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType3CharProc.java:148:
>> warning - @return tag has no arguments.
>> [WARNING]
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
>> warning - @inheritDoc used but getValue() does not override or implement
>> any method.
>> [WARNING]
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
>> warning - @inheritDoc used but getValue() does not override or implement
>> any method.
>> [WARNING]
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
>> warning - @inheritDoc used but getValue() does not override or implement
>> any method.
>> [WARNING]
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
>> warning - @inheritDoc used but getValue() does not override or implement
>> any method.
>> [INFO]
>> ------------------------------------------------------------------------
>> [INFO] BUILD SUCCESS
>> [INFO]
>> ------------------------------------------------------------------------
>> [INFO] Total time: 13.523 s
>> [INFO] Finished at: 2016-06-29T16:11:42-04:00
>> [INFO] Final Memory: 15M/245M
>> [INFO]
>> ------------------------------------------------------------------------
>>
>>
>> On Wed, Jun 29, 2016 at 3:25 PM, Tilman Hausherr <TH...@t-online.de>
>> wrote:
>>
>> Hi,
>>>
>>> But all these are warnings. When I fixed the errors, the errors could be
>>> found with "error:". Could you look if there are any, or if there's
>>> something else that makes it fail?
>>>
>>> Tilman
>>>
>>>
>>> Am 29.06.2016 um 20:09 schrieb Thad Humphries:
>>>
>>> I ran `mvn javadoc:javadoc -pl [module_name]` on each module
>>>> (svnversion 1750686) and still get failures on pdfbox and preflight (and
>>>> warnings on everyone; see below).
>>>>
>>>> Thanks for looking. I've been though this with our API docs, and know
>>>> that
>>>> Java 8's javadoc is a pain in the butt. For internal stuff,
>>>> "-Xdoclint:none" is my friend.
>>>>
>>>> $ mvn javadoc:javadoc -pl pdfbox
>>>> [INFO] Scanning for projects...
>>>> [INFO]
>>>>
>>>> [INFO]
>>>> ------------------------------------------------------------------------
>>>> [INFO] Building Apache PDFBox 2.1.0-SNAPSHOT
>>>> [INFO]
>>>> ------------------------------------------------------------------------
>>>> [INFO]
>>>> [INFO] >>> maven-javadoc-plugin:2.9.1:javadoc (default-cli) >
>>>> generate-sources @ pdfbox >>>
>>>> ...
>>>> 100 warnings
>>>> [INFO]
>>>> ------------------------------------------------------------------------
>>>> [INFO] BUILD FAILURE
>>>> [INFO]
>>>> ------------------------------------------------------------------------
>>>> [INFO] Total time: 9.980 s
>>>> [INFO] Finished at: 2016-06-29T13:59:08-04:00
>>>> [INFO] Final Memory: 18M/309M
>>>> [INFO]
>>>> ------------------------------------------------------------------------
>>>> [ERROR] Failed to execute goal
>>>> org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:javadoc
>>>> (default-cli)
>>>> on project pdfbox: An error has occurred in JavaDocs report generation:
>>>> [ERROR] Exit code: 1 -
>>>>
>>>>
>>>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/operator/OperatorProcessor.java:70:
>>>> warning: no @return
>>>> [ERROR] public abstract String getName();
>>>> [ERROR] ^
>>>> [ERROR]
>>>>
>>>>
>>>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:144:
>>>> warning: no description for @param
>>>> [ERROR] * @param fractionDigitsNumber
>>>> [ERROR] ^
>>>> [ERROR]
>>>>
>>>>
>>>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1336:
>>>> warning: no description for @param
>>>> [ERROR] * @param comment
>>>> [ERROR] ^
>>>> [ERROR]
>>>>
>>>>
>>>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1354:
>>>> warning: no description for @param
>>>> [ERROR] * @param data
>>>> [ERROR] ^
>>>> [ERROR]
>>>>
>>>>
>>>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1355:
>>>> warning: no description for @throws
>>>> [ERROR] * @throws java.io.IOException
>>>> [ERROR] ^
>>>> ...
>>>> (etc.)
>>>>
>>>> On Wed, Jun 29, 2016 at 1:27 PM, Tilman Hausherr <THausherr@t-online.de
>>>> >
>>>> wrote:
>>>>
>>>> Should work now. Thanks for pointing this out. I haven't changed the
>>>> pom,
>>>>
>>>>> I'll generate javadoc myself on a computer that has JDK8.
>>>>>
>>>>> Tilman
>>>>>
>>>>> Am 22.06.2016 um 21:58 schrieb Thad Humphries:
>>>>>
>>>>> When I tried to build the JavaDocs for PDFBox 2.1.0-SNAPSHOT (taken
>>>>> from
>>>>>
>>>>>> SVN yesterday) with Java 8, `mvn javadoc:javadoc` failed with numerous
>>>>>> errors. To correct this, I had to turn off the doclint by modifying
>>>>>> parent/pom.xml as follows:
>>>>>>
>>>>>> $ svn diff parent/pom.xml
>>>>>> Index: parent/pom.xml
>>>>>> ===================================================================
>>>>>> --- parent/pom.xml (revision 1749587)
>>>>>> +++ parent/pom.xml (working copy)
>>>>>> @@ -160,6 +160,7 @@
>>>>>> </links>
>>>>>> <encoding>UTF-8</encoding>
>>>>>> <notimestamp>true</notimestamp>
>>>>>> + <additionalparam>-Xdoclint:none</additionalparam>
>>>>>> </configuration>
>>>>>> </plugin>
>>>>>> <plugin>
>>>>>>
>>>>>> (Tip taken from
>>>>>> http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html
>>>>>> )
>>>>>>
>>>>>>
>>>>>> ---------------------------------------------------------------------
>>>>>>
>>>>> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
>>>>> For additional commands, e-mail: users-help@pdfbox.apache.org
>>>>>
>>>>>
>>>>>
>>>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
>>> For additional commands, e-mail: users-help@pdfbox.apache.org
>>>
>>>
>>>
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
>
--
"Hell hath no limits, nor is circumscrib'd In one self-place; but where we
are is hell, And where hell is, there must we ever be" --Christopher
Marlowe, *Doctor Faustus* (v. 121-24)
Re: Maven javadoc:javadoc errors with Java 8
Posted by Tilman Hausherr <TH...@t-online.de>.
But I did test with JDK8 and it worked, i.e. lots of warnings but no
errors. I did fix a lot of problems like the one mentioned by that website.
Do you have anything with "error:" (spelled exactly like that)?
Do you have any other settings that result in warnings being considered
to be [ERROR] ?
Could you post the full output? Maybe there's one single error I forgot
to fix.
Tilman
Am 29.06.2016 um 22:19 schrieb Thad Humphries:
> If I set JAVA_HOME to JDK 7 and use that as my path, `mvn javadoc:javadoc
> -pl pdfbox` runs with only a few warnings (see below). But if I run with JDK 8,
> there are many (lowercase) warning messages which result in [ERROR]s (as
> you can see by the previous email. The blog I cited in my first message (
> http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html)
> lists a bunch of things that are required by JDK 8's doclint. JDK 8 made *a
> lot* of changes to doclint.
>
>
> [WARNING] Javadoc Warnings
> [WARNING] warning: [options] bootstrap class path not set in conjunction
> with -source 1.6
> [WARNING]
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/StandardProtectionPolicy.java:120:
> warning - @return tag has no arguments.
> [WARNING]
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType3CharProc.java:148:
> warning - @return tag has no arguments.
> [WARNING]
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
> warning - @inheritDoc used but getValue() does not override or implement
> any method.
> [WARNING]
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
> warning - @inheritDoc used but getValue() does not override or implement
> any method.
> [WARNING]
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
> warning - @inheritDoc used but getValue() does not override or implement
> any method.
> [WARNING]
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
> warning - @inheritDoc used but getValue() does not override or implement
> any method.
> [INFO]
> ------------------------------------------------------------------------
> [INFO] BUILD SUCCESS
> [INFO]
> ------------------------------------------------------------------------
> [INFO] Total time: 13.523 s
> [INFO] Finished at: 2016-06-29T16:11:42-04:00
> [INFO] Final Memory: 15M/245M
> [INFO]
> ------------------------------------------------------------------------
>
>
> On Wed, Jun 29, 2016 at 3:25 PM, Tilman Hausherr <TH...@t-online.de>
> wrote:
>
>> Hi,
>>
>> But all these are warnings. When I fixed the errors, the errors could be
>> found with "error:". Could you look if there are any, or if there's
>> something else that makes it fail?
>>
>> Tilman
>>
>>
>> Am 29.06.2016 um 20:09 schrieb Thad Humphries:
>>
>>> I ran `mvn javadoc:javadoc -pl [module_name]` on each module
>>> (svnversion 1750686) and still get failures on pdfbox and preflight (and
>>> warnings on everyone; see below).
>>>
>>> Thanks for looking. I've been though this with our API docs, and know that
>>> Java 8's javadoc is a pain in the butt. For internal stuff,
>>> "-Xdoclint:none" is my friend.
>>>
>>> $ mvn javadoc:javadoc -pl pdfbox
>>> [INFO] Scanning for projects...
>>> [INFO]
>>>
>>> [INFO]
>>> ------------------------------------------------------------------------
>>> [INFO] Building Apache PDFBox 2.1.0-SNAPSHOT
>>> [INFO]
>>> ------------------------------------------------------------------------
>>> [INFO]
>>> [INFO] >>> maven-javadoc-plugin:2.9.1:javadoc (default-cli) >
>>> generate-sources @ pdfbox >>>
>>> ...
>>> 100 warnings
>>> [INFO]
>>> ------------------------------------------------------------------------
>>> [INFO] BUILD FAILURE
>>> [INFO]
>>> ------------------------------------------------------------------------
>>> [INFO] Total time: 9.980 s
>>> [INFO] Finished at: 2016-06-29T13:59:08-04:00
>>> [INFO] Final Memory: 18M/309M
>>> [INFO]
>>> ------------------------------------------------------------------------
>>> [ERROR] Failed to execute goal
>>> org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:javadoc (default-cli)
>>> on project pdfbox: An error has occurred in JavaDocs report generation:
>>> [ERROR] Exit code: 1 -
>>>
>>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/operator/OperatorProcessor.java:70:
>>> warning: no @return
>>> [ERROR] public abstract String getName();
>>> [ERROR] ^
>>> [ERROR]
>>>
>>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:144:
>>> warning: no description for @param
>>> [ERROR] * @param fractionDigitsNumber
>>> [ERROR] ^
>>> [ERROR]
>>>
>>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1336:
>>> warning: no description for @param
>>> [ERROR] * @param comment
>>> [ERROR] ^
>>> [ERROR]
>>>
>>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1354:
>>> warning: no description for @param
>>> [ERROR] * @param data
>>> [ERROR] ^
>>> [ERROR]
>>>
>>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1355:
>>> warning: no description for @throws
>>> [ERROR] * @throws java.io.IOException
>>> [ERROR] ^
>>> ...
>>> (etc.)
>>>
>>> On Wed, Jun 29, 2016 at 1:27 PM, Tilman Hausherr <TH...@t-online.de>
>>> wrote:
>>>
>>> Should work now. Thanks for pointing this out. I haven't changed the pom,
>>>> I'll generate javadoc myself on a computer that has JDK8.
>>>>
>>>> Tilman
>>>>
>>>> Am 22.06.2016 um 21:58 schrieb Thad Humphries:
>>>>
>>>> When I tried to build the JavaDocs for PDFBox 2.1.0-SNAPSHOT (taken from
>>>>> SVN yesterday) with Java 8, `mvn javadoc:javadoc` failed with numerous
>>>>> errors. To correct this, I had to turn off the doclint by modifying
>>>>> parent/pom.xml as follows:
>>>>>
>>>>> $ svn diff parent/pom.xml
>>>>> Index: parent/pom.xml
>>>>> ===================================================================
>>>>> --- parent/pom.xml (revision 1749587)
>>>>> +++ parent/pom.xml (working copy)
>>>>> @@ -160,6 +160,7 @@
>>>>> </links>
>>>>> <encoding>UTF-8</encoding>
>>>>> <notimestamp>true</notimestamp>
>>>>> + <additionalparam>-Xdoclint:none</additionalparam>
>>>>> </configuration>
>>>>> </plugin>
>>>>> <plugin>
>>>>>
>>>>> (Tip taken from
>>>>> http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html)
>>>>>
>>>>>
>>>>> ---------------------------------------------------------------------
>>>> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
>>>> For additional commands, e-mail: users-help@pdfbox.apache.org
>>>>
>>>>
>>>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
>> For additional commands, e-mail: users-help@pdfbox.apache.org
>>
>>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
Re: Maven javadoc:javadoc errors with Java 8
Posted by Thad Humphries <th...@gmail.com>.
If I set JAVA_HOME to JDK 7 and use that as my path, `mvn javadoc:javadoc
-pl pdfbox` runs with only a few warnings (see below). But if I run with JDK 8,
there are many (lowercase) warning messages which result in [ERROR]s (as
you can see by the previous email. The blog I cited in my first message (
http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html)
lists a bunch of things that are required by JDK 8's doclint. JDK 8 made *a
lot* of changes to doclint.
[WARNING] Javadoc Warnings
[WARNING] warning: [options] bootstrap class path not set in conjunction
with -source 1.6
[WARNING]
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/encryption/StandardProtectionPolicy.java:120:
warning - @return tag has no arguments.
[WARNING]
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/font/PDType3CharProc.java:148:
warning - @return tag has no arguments.
[WARNING]
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
warning - @inheritDoc used but getValue() does not override or implement
any method.
[WARNING]
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
warning - @inheritDoc used but getValue() does not override or implement
any method.
[WARNING]
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
warning - @inheritDoc used but getValue() does not override or implement
any method.
[WARNING]
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDNonTerminalField.java:172:
warning - @inheritDoc used but getValue() does not override or implement
any method.
[INFO]
------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO]
------------------------------------------------------------------------
[INFO] Total time: 13.523 s
[INFO] Finished at: 2016-06-29T16:11:42-04:00
[INFO] Final Memory: 15M/245M
[INFO]
------------------------------------------------------------------------
On Wed, Jun 29, 2016 at 3:25 PM, Tilman Hausherr <TH...@t-online.de>
wrote:
> Hi,
>
> But all these are warnings. When I fixed the errors, the errors could be
> found with "error:". Could you look if there are any, or if there's
> something else that makes it fail?
>
> Tilman
>
>
> Am 29.06.2016 um 20:09 schrieb Thad Humphries:
>
>> I ran `mvn javadoc:javadoc -pl [module_name]` on each module
>> (svnversion 1750686) and still get failures on pdfbox and preflight (and
>> warnings on everyone; see below).
>>
>> Thanks for looking. I've been though this with our API docs, and know that
>> Java 8's javadoc is a pain in the butt. For internal stuff,
>> "-Xdoclint:none" is my friend.
>>
>> $ mvn javadoc:javadoc -pl pdfbox
>> [INFO] Scanning for projects...
>> [INFO]
>>
>> [INFO]
>> ------------------------------------------------------------------------
>> [INFO] Building Apache PDFBox 2.1.0-SNAPSHOT
>> [INFO]
>> ------------------------------------------------------------------------
>> [INFO]
>> [INFO] >>> maven-javadoc-plugin:2.9.1:javadoc (default-cli) >
>> generate-sources @ pdfbox >>>
>> ...
>> 100 warnings
>> [INFO]
>> ------------------------------------------------------------------------
>> [INFO] BUILD FAILURE
>> [INFO]
>> ------------------------------------------------------------------------
>> [INFO] Total time: 9.980 s
>> [INFO] Finished at: 2016-06-29T13:59:08-04:00
>> [INFO] Final Memory: 18M/309M
>> [INFO]
>> ------------------------------------------------------------------------
>> [ERROR] Failed to execute goal
>> org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:javadoc (default-cli)
>> on project pdfbox: An error has occurred in JavaDocs report generation:
>> [ERROR] Exit code: 1 -
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/operator/OperatorProcessor.java:70:
>> warning: no @return
>> [ERROR] public abstract String getName();
>> [ERROR] ^
>> [ERROR]
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:144:
>> warning: no description for @param
>> [ERROR] * @param fractionDigitsNumber
>> [ERROR] ^
>> [ERROR]
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1336:
>> warning: no description for @param
>> [ERROR] * @param comment
>> [ERROR] ^
>> [ERROR]
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1354:
>> warning: no description for @param
>> [ERROR] * @param data
>> [ERROR] ^
>> [ERROR]
>>
>> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1355:
>> warning: no description for @throws
>> [ERROR] * @throws java.io.IOException
>> [ERROR] ^
>> ...
>> (etc.)
>>
>> On Wed, Jun 29, 2016 at 1:27 PM, Tilman Hausherr <TH...@t-online.de>
>> wrote:
>>
>> Should work now. Thanks for pointing this out. I haven't changed the pom,
>>> I'll generate javadoc myself on a computer that has JDK8.
>>>
>>> Tilman
>>>
>>> Am 22.06.2016 um 21:58 schrieb Thad Humphries:
>>>
>>> When I tried to build the JavaDocs for PDFBox 2.1.0-SNAPSHOT (taken from
>>>> SVN yesterday) with Java 8, `mvn javadoc:javadoc` failed with numerous
>>>> errors. To correct this, I had to turn off the doclint by modifying
>>>> parent/pom.xml as follows:
>>>>
>>>> $ svn diff parent/pom.xml
>>>> Index: parent/pom.xml
>>>> ===================================================================
>>>> --- parent/pom.xml (revision 1749587)
>>>> +++ parent/pom.xml (working copy)
>>>> @@ -160,6 +160,7 @@
>>>> </links>
>>>> <encoding>UTF-8</encoding>
>>>> <notimestamp>true</notimestamp>
>>>> + <additionalparam>-Xdoclint:none</additionalparam>
>>>> </configuration>
>>>> </plugin>
>>>> <plugin>
>>>>
>>>> (Tip taken from
>>>> http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html)
>>>>
>>>>
>>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
>>> For additional commands, e-mail: users-help@pdfbox.apache.org
>>>
>>>
>>>
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
>
--
"Hell hath no limits, nor is circumscrib'd In one self-place; but where we
are is hell, And where hell is, there must we ever be" --Christopher
Marlowe, *Doctor Faustus* (v. 121-24)
Re: Maven javadoc:javadoc errors with Java 8
Posted by Tilman Hausherr <TH...@t-online.de>.
Hi,
But all these are warnings. When I fixed the errors, the errors could be
found with "error:". Could you look if there are any, or if there's
something else that makes it fail?
Tilman
Am 29.06.2016 um 20:09 schrieb Thad Humphries:
> I ran `mvn javadoc:javadoc -pl [module_name]` on each module
> (svnversion 1750686) and still get failures on pdfbox and preflight (and
> warnings on everyone; see below).
>
> Thanks for looking. I've been though this with our API docs, and know that
> Java 8's javadoc is a pain in the butt. For internal stuff,
> "-Xdoclint:none" is my friend.
>
> $ mvn javadoc:javadoc -pl pdfbox
> [INFO] Scanning for projects...
> [INFO]
>
> [INFO]
> ------------------------------------------------------------------------
> [INFO] Building Apache PDFBox 2.1.0-SNAPSHOT
> [INFO]
> ------------------------------------------------------------------------
> [INFO]
> [INFO] >>> maven-javadoc-plugin:2.9.1:javadoc (default-cli) >
> generate-sources @ pdfbox >>>
> ...
> 100 warnings
> [INFO]
> ------------------------------------------------------------------------
> [INFO] BUILD FAILURE
> [INFO]
> ------------------------------------------------------------------------
> [INFO] Total time: 9.980 s
> [INFO] Finished at: 2016-06-29T13:59:08-04:00
> [INFO] Final Memory: 18M/309M
> [INFO]
> ------------------------------------------------------------------------
> [ERROR] Failed to execute goal
> org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:javadoc (default-cli)
> on project pdfbox: An error has occurred in JavaDocs report generation:
> [ERROR] Exit code: 1 -
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/operator/OperatorProcessor.java:70:
> warning: no @return
> [ERROR] public abstract String getName();
> [ERROR] ^
> [ERROR]
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:144:
> warning: no description for @param
> [ERROR] * @param fractionDigitsNumber
> [ERROR] ^
> [ERROR]
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1336:
> warning: no description for @param
> [ERROR] * @param comment
> [ERROR] ^
> [ERROR]
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1354:
> warning: no description for @param
> [ERROR] * @param data
> [ERROR] ^
> [ERROR]
> /Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1355:
> warning: no description for @throws
> [ERROR] * @throws java.io.IOException
> [ERROR] ^
> ...
> (etc.)
>
> On Wed, Jun 29, 2016 at 1:27 PM, Tilman Hausherr <TH...@t-online.de>
> wrote:
>
>> Should work now. Thanks for pointing this out. I haven't changed the pom,
>> I'll generate javadoc myself on a computer that has JDK8.
>>
>> Tilman
>>
>> Am 22.06.2016 um 21:58 schrieb Thad Humphries:
>>
>>> When I tried to build the JavaDocs for PDFBox 2.1.0-SNAPSHOT (taken from
>>> SVN yesterday) with Java 8, `mvn javadoc:javadoc` failed with numerous
>>> errors. To correct this, I had to turn off the doclint by modifying
>>> parent/pom.xml as follows:
>>>
>>> $ svn diff parent/pom.xml
>>> Index: parent/pom.xml
>>> ===================================================================
>>> --- parent/pom.xml (revision 1749587)
>>> +++ parent/pom.xml (working copy)
>>> @@ -160,6 +160,7 @@
>>> </links>
>>> <encoding>UTF-8</encoding>
>>> <notimestamp>true</notimestamp>
>>> + <additionalparam>-Xdoclint:none</additionalparam>
>>> </configuration>
>>> </plugin>
>>> <plugin>
>>>
>>> (Tip taken from
>>> http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html)
>>>
>>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
>> For additional commands, e-mail: users-help@pdfbox.apache.org
>>
>>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
Re: Maven javadoc:javadoc errors with Java 8
Posted by Thad Humphries <th...@gmail.com>.
I ran `mvn javadoc:javadoc -pl [module_name]` on each module
(svnversion 1750686) and still get failures on pdfbox and preflight (and
warnings on everyone; see below).
Thanks for looking. I've been though this with our API docs, and know that
Java 8's javadoc is a pain in the butt. For internal stuff,
"-Xdoclint:none" is my friend.
$ mvn javadoc:javadoc -pl pdfbox
[INFO] Scanning for projects...
[INFO]
[INFO]
------------------------------------------------------------------------
[INFO] Building Apache PDFBox 2.1.0-SNAPSHOT
[INFO]
------------------------------------------------------------------------
[INFO]
[INFO] >>> maven-javadoc-plugin:2.9.1:javadoc (default-cli) >
generate-sources @ pdfbox >>>
...
100 warnings
[INFO]
------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO]
------------------------------------------------------------------------
[INFO] Total time: 9.980 s
[INFO] Finished at: 2016-06-29T13:59:08-04:00
[INFO] Final Memory: 18M/309M
[INFO]
------------------------------------------------------------------------
[ERROR] Failed to execute goal
org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:javadoc (default-cli)
on project pdfbox: An error has occurred in JavaDocs report generation:
[ERROR] Exit code: 1 -
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/operator/OperatorProcessor.java:70:
warning: no @return
[ERROR] public abstract String getName();
[ERROR] ^
[ERROR]
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:144:
warning: no description for @param
[ERROR] * @param fractionDigitsNumber
[ERROR] ^
[ERROR]
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1336:
warning: no description for @param
[ERROR] * @param comment
[ERROR] ^
[ERROR]
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1354:
warning: no description for @param
[ERROR] * @param data
[ERROR] ^
[ERROR]
/Users/thad/jdevel/pdfbox-2.1.0-SNAPSHOT/pdfbox/src/main/java/org/apache/pdfbox/contentstream/PDAbstractContentStream.java:1355:
warning: no description for @throws
[ERROR] * @throws java.io.IOException
[ERROR] ^
...
(etc.)
On Wed, Jun 29, 2016 at 1:27 PM, Tilman Hausherr <TH...@t-online.de>
wrote:
> Should work now. Thanks for pointing this out. I haven't changed the pom,
> I'll generate javadoc myself on a computer that has JDK8.
>
> Tilman
>
> Am 22.06.2016 um 21:58 schrieb Thad Humphries:
>
>> When I tried to build the JavaDocs for PDFBox 2.1.0-SNAPSHOT (taken from
>> SVN yesterday) with Java 8, `mvn javadoc:javadoc` failed with numerous
>> errors. To correct this, I had to turn off the doclint by modifying
>> parent/pom.xml as follows:
>>
>> $ svn diff parent/pom.xml
>> Index: parent/pom.xml
>> ===================================================================
>> --- parent/pom.xml (revision 1749587)
>> +++ parent/pom.xml (working copy)
>> @@ -160,6 +160,7 @@
>> </links>
>> <encoding>UTF-8</encoding>
>> <notimestamp>true</notimestamp>
>> + <additionalparam>-Xdoclint:none</additionalparam>
>> </configuration>
>> </plugin>
>> <plugin>
>>
>> (Tip taken from
>> http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html)
>>
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
> For additional commands, e-mail: users-help@pdfbox.apache.org
>
>
--
"Hell hath no limits, nor is circumscrib'd In one self-place; but where we
are is hell, And where hell is, there must we ever be" --Christopher
Marlowe, *Doctor Faustus* (v. 121-24)
Re: Maven javadoc:javadoc errors with Java 8
Posted by Tilman Hausherr <TH...@t-online.de>.
Should work now. Thanks for pointing this out. I haven't changed the
pom, I'll generate javadoc myself on a computer that has JDK8.
Tilman
Am 22.06.2016 um 21:58 schrieb Thad Humphries:
> When I tried to build the JavaDocs for PDFBox 2.1.0-SNAPSHOT (taken from
> SVN yesterday) with Java 8, `mvn javadoc:javadoc` failed with numerous
> errors. To correct this, I had to turn off the doclint by modifying
> parent/pom.xml as follows:
>
> $ svn diff parent/pom.xml
> Index: parent/pom.xml
> ===================================================================
> --- parent/pom.xml (revision 1749587)
> +++ parent/pom.xml (working copy)
> @@ -160,6 +160,7 @@
> </links>
> <encoding>UTF-8</encoding>
> <notimestamp>true</notimestamp>
> + <additionalparam>-Xdoclint:none</additionalparam>
> </configuration>
> </plugin>
> <plugin>
>
> (Tip taken from
> http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html)
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org
Re: Maven javadoc:javadoc errors with Java 8
Posted by Tilman Hausherr <TH...@t-online.de>.
Thanks... I'll fix the javadoc from time to time.
Tilman
Am 22.06.2016 um 21:58 schrieb Thad Humphries:
> When I tried to build the JavaDocs for PDFBox 2.1.0-SNAPSHOT (taken from
> SVN yesterday) with Java 8, `mvn javadoc:javadoc` failed with numerous
> errors. To correct this, I had to turn off the doclint by modifying
> parent/pom.xml as follows:
>
> $ svn diff parent/pom.xml
> Index: parent/pom.xml
> ===================================================================
> --- parent/pom.xml (revision 1749587)
> +++ parent/pom.xml (working copy)
> @@ -160,6 +160,7 @@
> </links>
> <encoding>UTF-8</encoding>
> <notimestamp>true</notimestamp>
> + <additionalparam>-Xdoclint:none</additionalparam>
> </configuration>
> </plugin>
> <plugin>
>
> (Tip taken from
> http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html)
>
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@pdfbox.apache.org
For additional commands, e-mail: users-help@pdfbox.apache.org