Update the JavaDocs for PDFBOX 2.x

Contribute

If you would like to submit a javadoc patch through Jira, please open a ticket at our Issue Tracker and use Documentation for the Component.

Publish (for committers only)

To publish the javadocs follow these steps:

Add the following server configuration in your ~/.m2/settings.xml file

<server>
  <id>pdfbox-site</id>
  <username>** USERNAME **</username>
  <password>** PASSWORD **</password>
</server>

pdfbox-site is referenced from the PDFBox pom.xml file.

The password should be encrypted following Maven Password Encryption

Run

$ mvn clean javadoc:aggregate scm-publish:publish-scm

from the <SVN_ROOT>/../pdfbox directory.

As mvn clean will delete the javadoc files download from the Apache CMS it's advised to configure ${svn.scmJavadocCheckoutDirectory} to a local directory not below ./target.