Author: tilman Date: Wed Dec 6 18:42:35 2023 New Revision: 1914392 URL: http://svn.apache.org/viewvc?rev=1914392&view=rev Log: PDFBOX-5660: fix javadoc, by Axel Howind
Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/ColorBarCellRenderer.java pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/DeviceNTableModel.java pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/IndexedColorant.java pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/IndexedTableModel.java pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/PDFTreeModel.java pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/lucene/LucenePDFDocument.java pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyfSimpleDescript.java pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/type1/Type1Parser.java pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/util/autodetect/UnixFontDirFinder.java pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/handlers/PDFileAttachmentAppearanceHandler.java Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/ColorBarCellRenderer.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/ColorBarCellRenderer.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/ColorBarCellRenderer.java (original) +++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/ColorBarCellRenderer.java Wed Dec 6 18:42:35 2023 @@ -23,11 +23,8 @@ import javax.swing.JTable; import javax.swing.table.TableCellRenderer; /** - * @author Khyrul Bashar. - */ - -/** * ColorBarCellRenderer class that says how to render color bar columns + * @author Khyrul Bashar. */ public class ColorBarCellRenderer implements TableCellRenderer { Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/DeviceNTableModel.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/DeviceNTableModel.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/DeviceNTableModel.java (original) +++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/DeviceNTableModel.java Wed Dec 6 18:42:35 2023 @@ -20,11 +20,8 @@ import java.awt.Color; import javax.swing.table.AbstractTableModel; /** - * @author Khyrul Bashar. - */ - -/** * This the table model for showing DeviceN color space which extends AbstractTableModel. + * @author Khyrul Bashar. */ @SuppressWarnings({"serial","squid:S1948"}) public class DeviceNTableModel extends AbstractTableModel Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/IndexedColorant.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/IndexedColorant.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/IndexedColorant.java (original) +++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/IndexedColorant.java Wed Dec 6 18:42:35 2023 @@ -19,11 +19,8 @@ package org.apache.pdfbox.debugger.color import java.awt.Color; /** - * @author Khyrul Bashar. - */ - -/** * Class to represent Colorant in Indexed color. + * @author Khyrul Bashar. */ public class IndexedColorant { Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/IndexedTableModel.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/IndexedTableModel.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/IndexedTableModel.java (original) +++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/IndexedTableModel.java Wed Dec 6 18:42:35 2023 @@ -20,11 +20,8 @@ import java.awt.Color; import javax.swing.table.AbstractTableModel; /** - * @author Khyrul Bashar. - */ - -/** * This the table model for showing Indexed color space which extends AbstractTableModel. + * @author Khyrul Bashar. */ @SuppressWarnings({"serial","squid:S1948"}) public class IndexedTableModel extends AbstractTableModel Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/PDFTreeModel.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/PDFTreeModel.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/PDFTreeModel.java (original) +++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/PDFTreeModel.java Wed Dec 6 18:42:35 2023 @@ -16,13 +16,6 @@ */ package org.apache.pdfbox.debugger.ui; -/** - * A tree model that uses a cos document. - * - * - * @author wurtz - * @author Ben Litchfield - */ import java.util.ArrayList; import java.util.Collections; import java.util.List; @@ -40,6 +33,7 @@ import org.apache.pdfbox.pdmodel.PDDocum /** * A class to model a PDF document as a tree structure. * + * @author wurtz * @author Ben Litchfield */ public class PDFTreeModel implements TreeModel Modified: pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/lucene/LucenePDFDocument.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/lucene/LucenePDFDocument.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/lucene/LucenePDFDocument.java (original) +++ pdfbox/trunk/examples/src/main/java/org/apache/pdfbox/examples/lucene/LucenePDFDocument.java Wed Dec 6 18:42:35 2023 @@ -47,7 +47,6 @@ import org.apache.pdfbox.text.PDFTextStr * This class is used to create a document for the lucene search engine. This should easily plug into the IndexPDFFiles * that comes with the lucene project. This class will populate the following fields. * <table> - * <caption></caption> * <tr> * <th>Lucene Field Name</th> * <th>Description</th> Modified: pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyfSimpleDescript.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyfSimpleDescript.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyfSimpleDescript.java (original) +++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/ttf/GlyfSimpleDescript.java Wed Dec 6 18:42:35 2023 @@ -33,8 +33,6 @@ public class GlyfSimpleDescript extends /** * Constructor for an empty description. - * - * @throws IOException is thrown if something went wrong */ GlyfSimpleDescript() { Modified: pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/type1/Type1Parser.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/type1/Type1Parser.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/type1/Type1Parser.java (original) +++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/type1/Type1Parser.java Wed Dec 6 18:42:35 2023 @@ -884,8 +884,6 @@ final class Type1Parser /** * Reads the next token and throws an exception if it is not of the given kind * and does not have the given value. - * - * @return token, never null */ private void read(Token.Kind kind, String name) throws IOException { Modified: pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/util/autodetect/UnixFontDirFinder.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/util/autodetect/UnixFontDirFinder.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/util/autodetect/UnixFontDirFinder.java (original) +++ pdfbox/trunk/fontbox/src/main/java/org/apache/fontbox/util/autodetect/UnixFontDirFinder.java Wed Dec 6 18:42:35 2023 @@ -27,7 +27,7 @@ public class UnixFontDirFinder extends N /** * Some guesses at possible unix font directory locations. * - * @return a list of possible font locations + * @return an array of possible font locations */ @Override protected String[] getSearchableDirectories() Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java (original) +++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java Wed Dec 6 18:42:35 2023 @@ -94,7 +94,7 @@ public class PDDocument implements Close private static final Logger LOG = LogManager.getLogger(PDDocument.class); - /** + /* * avoid concurrency issues with PDDeviceRGB */ static Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/handlers/PDFileAttachmentAppearanceHandler.java URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/handlers/PDFileAttachmentAppearanceHandler.java?rev=1914392&r1=1914391&r2=1914392&view=diff ============================================================================== --- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/handlers/PDFileAttachmentAppearanceHandler.java (original) +++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/annotation/handlers/PDFileAttachmentAppearanceHandler.java Wed Dec 6 18:42:35 2023 @@ -75,7 +75,7 @@ public class PDFileAttachmentAppearanceH /** * Draw a paperclip. Shape is from - * <a href="https://raw.githubusercontent.com/Iconscout/unicons/master/svg/line/paperclip.svg>Iconscout</a> + * <a href="https://raw.githubusercontent.com/Iconscout/unicons/master/svg/line/paperclip.svg">Iconscout</a> * (Apache licensed). * * @param contentStream