Author: tilman
Date: Wed May 22 06:43:13 2024
New Revision: 1917879
URL: http://svn.apache.org/viewvc?rev=1917879&view=rev
Log:
PDFBOX-5825: improve javadoc
Modified:
pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDMetadata.java
Modified:
pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDMetadata.java
URL:
http://svn.apache.org/viewvc/pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDMetadata.java?rev=1917879&r1=1917878&r2=1917879&view=diff
==============================================================================
---
pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDMetadata.java
(original)
+++
pdfbox/branches/3.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/PDMetadata.java
Wed May 22 06:43:13 2024
@@ -35,7 +35,8 @@ public class PDMetadata extends PDStream
{
/**
- * This will create a new PDMetadata object.
+ * This will create a new PDMetadata object with the /Type and /Subtype
entries for a document
+ * level metadata object.
*
* @param document The document that the stream will be part of.
*/
@@ -47,8 +48,9 @@ public class PDMetadata extends PDStream
}
/**
- * Constructor. Reads all data from the input stream and embeds it into
the
- * document, this will close the InputStream.
+ * Constructor. Reads all data from the input stream and embeds it into
the document, this will
+ * close the InputStream. The /Type and /Subtype entries for a document
level metadata object
+ * will be created.
*
* @param doc The document that will hold the stream.
* @param str The stream parameter.
@@ -62,7 +64,7 @@ public class PDMetadata extends PDStream
}
/**
- * Constructor.
+ * Constructor. This will <b>not</b> set up the /Type and /Subtype entries.
*
* @param str The stream parameter.
*/
