You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2016/06/28 15:35:54 UTC

svn commit: r1750538 - in /pdfbox/trunk: examples/src/main/java/org/apache/pdfbox/examples/lucene/ examples/src/main/java/org/apache/pdfbox/examples/signature/ tools/src/main/java/org/apache/pdfbox/tools/imageio/

Author: tilman
Date: Tue Jun 28 15:35:54 2016
New Revision: 1750538

URL: http://svn.apache.org/viewvc?rev=1750538&view=rev
Log:
PDFBOX-2852: fix javadoc

Modified:
    pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/lucene/LucenePDFDocument.java
    pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java
    pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/imageio/TIFFUtil.java

Modified: pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/lucene/LucenePDFDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/lucene/LucenePDFDocument.java?rev=1750538&r1=1750537&r2=1750538&view=diff
==============================================================================
--- pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/lucene/LucenePDFDocument.java (original)
+++ pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/lucene/LucenePDFDocument.java Tue Jun 28 15:35:54 2016
@@ -43,6 +43,7 @@ import org.apache.pdfbox.text.PDFTextStr
  * This class is used to create a document for the lucene search engine. This should easily plug into the IndexPDFFiles
  * that comes with the lucene project. This class will populate the following fields.
  * <table>
+ * <caption></caption>
  * <tr>
  * <th>Lucene Field Name</th>
  * <th>Description</th>

Modified: pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java?rev=1750538&r1=1750537&r2=1750538&view=diff
==============================================================================
--- pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java (original)
+++ pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/signature/CreateSignatureBase.java Tue Jun 28 15:35:54 2016
@@ -139,13 +139,14 @@ public abstract class CreateSignatureBas
      * This method will be called from inside of the pdfbox and create the PKCS #7 signature.
      * The given InputStream contains the bytes that are given by the byte range.
      *
-     * This method is for internal use only. <-- TODO this method should be private
+     * This method is for internal use only.
      *
      * Use your favorite cryptographic library to implement PKCS #7 signature creation.
      */
     @Override
     public byte[] sign(InputStream content) throws IOException
     {
+        //TODO this method should be private
         try
         {
             List<Certificate> certList = new ArrayList<Certificate>();

Modified: pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/imageio/TIFFUtil.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/imageio/TIFFUtil.java?rev=1750538&r1=1750537&r2=1750538&view=diff
==============================================================================
--- pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/imageio/TIFFUtil.java (original)
+++ pdfbox/trunk/tools/src/main/java/org/apache/pdfbox/tools/imageio/TIFFUtil.java Tue Jun 28 15:35:54 2016
@@ -76,12 +76,14 @@ final class TIFFUtil
     }
 
     /**
-     * Updates the given ImageIO metadata with Sun's custom TIFF tags.
-     * {@see https://svn.apache.org/repos/asf/xmlgraphics/commons/tags/commons-1_3_1/src/java/org/
-     *       apache/xmlgraphics/image/writer/imageio/ImageIOTIFFImageWriter.java}
-     * {@see http://download.java.net/media/jai-imageio/javadoc/1.0_01/com/sun/media/imageio/
-     *       plugins/tiff/package-summary.html}
-     * {@see http://partners.adobe.com/public/developer/tiff/index.html}
+     * Updates the given ImageIO metadata with Sun's custom TIFF tags, as described in
+     * the <a href="https://svn.apache.org/repos/asf/xmlgraphics/commons/tags/commons-1_3_1/src/java/org/apache/xmlgraphics/image/writer/imageio/ImageIOTIFFImageWriter.java">org.apache.xmlgraphics.image.writer.imageio.ImageIOTIFFImageWriter
+     * sources</a>, 
+     * the <a href="http://download.java.net/media/jai-imageio/javadoc/1.0_01/com/sun/media/imageio/plugins/tiff/package-summary.html">com.sun.media.imageio.plugins.tiff
+     * package javadoc</a>
+     * and the <a href="http://partners.adobe.com/public/developer/tiff/index.html">TIFF
+     * specification</a>.
+     *
      * @param image buffered image which will be written
      * @param metadata ImageIO metadata
      * @param dpi image dots per inch