pdfbox-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Thad Humphries <thad.humphr...@gmail.com>
Subject Re: Maven javadoc:javadoc errors with Java 8
Date Wed, 29 Jun 2016 18:09:18 GMT
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
>
>


-- 
"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)

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message