You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by le...@apache.org on 2018/03/19 17:50:06 UTC
svn commit: r1827219 - in
/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos:
COSDocument.java COSInputStream.java COSString.java
Author: lehmi
Date: Mon Mar 19 17:50:06 2018
New Revision: 1827219
URL: http://svn.apache.org/viewvc?rev=1827219&view=rev
Log:
PDFBOX-4071: fix javadoc
Modified:
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSInputStream.java
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java?rev=1827219&r1=1827218&r2=1827219&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java Mon Mar 19 17:50:06 2018
@@ -359,7 +359,7 @@ public class COSDocument extends COSBase
/**
* This will get the document catalog.
*
- * @return @return The catalog is the root of the document; never null.
+ * @return The catalog is the root of the document; never null.
*
* @throws IOException If no catalog can be found.
*/
@@ -450,6 +450,8 @@ public class COSDocument extends COSBase
/**
* Returns true if this document has been closed.
+ *
+ * @return true if the documnet has been closed.
*/
public boolean isClosed()
{
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSInputStream.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSInputStream.java?rev=1827219&r1=1827218&r2=1827219&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSInputStream.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSInputStream.java Mon Mar 19 17:50:06 2018
@@ -114,6 +114,8 @@ public final class COSInputStream extend
/**
* Returns the result of the last filter, for use by repair mechanisms.
+ *
+ * @return the result of the decoding.
*/
public DecodeResult getDecodeResult()
{
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java?rev=1827219&r1=1827218&r2=1827219&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java Mon Mar 19 17:50:06 2018
@@ -173,6 +173,8 @@ public final class COSString extends COS
/**
* Returns true if the string is to be written in hex form.
+ *
+ * @return the hex representation of this string.
*/
public boolean getForceHexForm()
{
@@ -181,6 +183,8 @@ public final class COSString extends COS
/**
* Returns the content of this string as a PDF <i>text string</i>.
+ *
+ * @return the string representation of this string using the given encoding.
*/
public String getString()
{
@@ -198,13 +202,14 @@ public final class COSString extends COS
return new String(bytes, 2, bytes.length - 2, Charsets.UTF_16LE);
}
}
-
// otherwise use PDFDocEncoding
return PDFDocEncoding.toString(bytes);
}
/**
* Returns the content of this string as a PDF <i>ASCII string</i>.
+ *
+ * @return the ASCII representation of this string.
*/
public String getASCII()
{
@@ -214,6 +219,8 @@ public final class COSString extends COS
/**
* Returns the raw bytes of the string. Best used with a PDF <i>byte string</i>.
+ *
+ * @return the raw bytes of this string.
*/
public byte[] getBytes()
{