PDFBOX-5660: improve javadoc

THausherr · THausherr · commit 8c048aaa7351 · 2025-10-27T13:23:36.000Z
git-svn-id: https://svn.apache.org/repos/asf/pdfbox/trunk@1929374 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDOutputIntent.java b/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/color/PDOutputIntent.java
@@ -40,6 +40,14 @@ public final class PDOutputIntent implements COSObjectable
 {
     private final COSDictionary dictionary;
 
+    /**
+     * Create an output intent of GTS_PDFA1 subtype.
+     *
+     * @param doc The document.
+     * @param colorProfile the ICC color profile input stream. You can close it after construction.
+     * @throws IOException If an I/O error occurs while reading the stream.
+     * @throws IllegalArgumentException If the stream does not contain valid ICC Profile data.
+     */
     public PDOutputIntent(PDDocument doc, InputStream colorProfile) throws IOException
     {
         dictionary = new COSDictionary();

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,14 @@ public final class PDOutputIntent implements COSObjectable`
`40`	`40`	`{`
`41`	`41`	`private final COSDictionary dictionary;`
`42`	`42`
	`43`	`+ /**`
	`44`	`+ * Create an output intent of GTS_PDFA1 subtype.`
	`45`	`+ *`
	`46`	`+ * @param doc The document.`
	`47`	`+ * @param colorProfile the ICC color profile input stream. You can close it after construction.`
	`48`	`+ * @throws IOException If an I/O error occurs while reading the stream.`
	`49`	`+ * @throws IllegalArgumentException If the stream does not contain valid ICC Profile data.`
	`50`	`+ */`
`43`	`51`	`public PDOutputIntent(PDDocument doc, InputStream colorProfile) throws IOException`
`44`	`52`	`{`
`45`	`53`	`dictionary = new COSDictionary();`