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 2019/08/23 15:42:25 UTC

svn commit: r1865761 - in /pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox: cos/COSStream.java pdmodel/common/COSStreamArray.java

Author: tilman
Date: Fri Aug 23 15:42:25 2019
New Revision: 1865761

URL: http://svn.apache.org/viewvc?rev=1865761&view=rev
Log:
PDFBOX-4071: improve javadoc

Modified:
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSStream.java
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSStreamArray.java

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSStream.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSStream.java?rev=1865761&r1=1865760&r2=1865761&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSStream.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/cos/COSStream.java Fri Aug 23 15:42:25 2019
@@ -452,9 +452,11 @@ public class COSStream extends COSDictio
     /**
      * This will return the filters to apply to the byte stream.
      * The method will return
-     * - null if no filters are to be applied
-     * - a COSName if one filter is to be applied
-     * - a COSArray containing COSNames if multiple filters are to be applied
+     * <ul>
+     * <li>null if no filters are to be applied
+     * <li>a COSName if one filter is to be applied
+     * <li>a COSArray containing COSNames if multiple filters are to be applied
+     * </ul>
      *
      * @return the COSBase object representing the filters
      */

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSStreamArray.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSStreamArray.java?rev=1865761&r1=1865760&r2=1865761&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSStreamArray.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/COSStreamArray.java Fri Aug 23 15:42:25 2019
@@ -221,9 +221,11 @@ public class COSStreamArray extends COSS
     /**
      * This will return the filters to apply to the byte stream
      * the method will return.
-     * - null if no filters are to be applied
-     * - a COSName if one filter is to be applied
-     * - a COSArray containing COSNames if multiple filters are to be applied
+     * <ul>
+     * <li>null if no filters are to be applied
+     * <li>a COSName if one filter is to be applied
+     * <li>a COSArray containing COSNames if multiple filters are to be applied
+     * </ul>
      *
      * @return the COSBase object representing the filters
      */