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 2018/03/16 17:02:44 UTC

svn commit: r1827021 - in /pdfbox/branches/2.0: debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java

Author: tilman
Date: Fri Mar 16 17:02:44 2018
New Revision: 1827021

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

Modified:
    pdfbox/branches/2.0/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java

Modified: pdfbox/branches/2.0/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java?rev=1827021&r1=1827020&r2=1827021&view=diff
==============================================================================
--- pdfbox/branches/2.0/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java (original)
+++ pdfbox/branches/2.0/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java Fri Mar 16 17:02:44 2018
@@ -90,7 +90,6 @@ public class CSArrayBased
         if (colorSpace instanceof PDICCBased)
         {
             PDICCBased icc = (PDICCBased) colorSpace;
-            //TODO the javadoc of getColorSpaceType is incomplete?
             int colorSpaceType = icc.getColorSpaceType();
             String cs;
             switch (colorSpaceType)

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java?rev=1827021&r1=1827020&r2=1827021&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java Fri Mar 16 17:02:44 2018
@@ -385,9 +385,13 @@ public final class PDICCBased extends PD
     }
 
     /**
-     * Returns the type of the color space in the ICC profile.
-     * Will be one of {@code TYPE_GRAY}, {@code TYPE_RGB}, or {@code TYPE_CMYK}.
-     * @return an ICC color space type
+     * Returns the type of the color space in the ICC profile. If the ICC profile is invalid, the
+     * type of the alternate colorspace is returned, which will be one of
+     * {@link ColorSpace#TYPE_GRAY TYPE_GRAY}, {@link ColorSpace#TYPE_RGB TYPE_RGB},
+     * {@link ColorSpace#TYPE_CMYK TYPE_CMYK}, or -1 if that one is invalid.
+     *
+     * @return an ICC color space type. See {@link ColorSpace#getType()} and the static values of
+     * {@link ColorSpace} for more details.
      */
     public int getColorSpaceType()
     {