Author: tilman
Date: Fri Mar 16 17:02:39 2018
New Revision: 1827020
URL: http://svn.apache.org/viewvc?rev=1827020&view=rev
Log:
PDFBOX-4071: improve javadoc
Modified:
pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java
Modified:
pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java?rev=1827020&r1=1827019&r2=1827020&view=diff
==============================================================================
---
pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java
(original)
+++
pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSArrayBased.java
Fri Mar 16 17:02:39 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/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java
URL:
http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java?rev=1827020&r1=1827019&r2=1827020&view=diff
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java
(original)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDICCBased.java
Fri Mar 16 17:02:39 2018
@@ -377,9 +377,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()
{
