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 2015/10/13 18:56:38 UTC
svn commit: r1708468 -
/pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/utils/COSUtils.java
Author: tilman
Date: Tue Oct 13 16:56:38 2015
New Revision: 1708468
URL: http://svn.apache.org/viewvc?rev=1708468&view=rev
Log:
PDFBOX-2852: improve javadoc
Modified:
pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/utils/COSUtils.java
Modified: pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/utils/COSUtils.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/utils/COSUtils.java?rev=1708468&r1=1708467&r2=1708468&view=diff
==============================================================================
--- pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/utils/COSUtils.java (original)
+++ pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/utils/COSUtils.java Tue Oct 13 16:56:38 2015
@@ -73,11 +73,11 @@ public final class COSUtils
}
/**
- * return true if the elt is a COSString or a reference to a COSString
+ * return true if the elt is a COSString or a COSName or a reference to it.
*
* @param elt the object to check.
* @param doc the document.
- * @return true if the object is a COSString or a reference to it.
+ * @return true if the object is a COSString or a COSName or a reference to it.
*/
public static boolean isString(COSBase elt, COSDocument doc)
{
@@ -255,12 +255,13 @@ public final class COSUtils
}
/**
- * Return the COSBase object as COSString if the COSBase object is an instance of COSString or a reference to a
- * COSString object. In other cases, this method returns null;
- *
+ * Return the COSBase object as String if the COSBase object is an instance of COSString or
+ * COSName or a reference to it.
+ *
* @param cbase the object to get.
* @param cDoc the document.
- * @return the object as COSString if the object is a COSString or a reference to it. Returns null otherwise.
+ * @return the object as String if the object is a COSString or COSName or reference to it.
+ * Returns null otherwise.
*/
public static String getAsString(COSBase cbase, COSDocument cDoc)
{