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 2022/11/14 07:11:38 UTC

svn commit: r1905290 - in /pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger: colorpane/ flagbitspane/ treestatus/ ui/

Author: lehmi
Date: Mon Nov 14 07:11:37 2022
New Revision: 1905290

URL: http://svn.apache.org/viewvc?rev=1905290&view=rev
Log:
PDFBOX-4892: fix javadoc

Modified:
    pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSDeviceN.java
    pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSIndexed.java
    pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSSeparation.java
    pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/FlagBitsPane.java
    pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/treestatus/TreeStatus.java
    pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/treestatus/TreeStatusPane.java
    pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/PrintDpiMenu.java
    pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/ViewMenu.java

Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSDeviceN.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSDeviceN.java?rev=1905290&r1=1905289&r2=1905290&view=diff
==============================================================================
--- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSDeviceN.java (original)
+++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSDeviceN.java Mon Nov 14 07:11:37 2022
@@ -46,6 +46,8 @@ public class CSDeviceN
      * Constructor
      *
      * @param array COSArray instance that holds the DeviceN color space
+     * 
+     * @throws IOException if the instance could not be created
      */
     public CSDeviceN(COSArray array) throws IOException
     {

Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSIndexed.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSIndexed.java?rev=1905290&r1=1905289&r2=1905290&view=diff
==============================================================================
--- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSIndexed.java (original)
+++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSIndexed.java Mon Nov 14 07:11:37 2022
@@ -46,8 +46,9 @@ public class CSIndexed
 
     /**
      * Constructor.
+     * 
      * @param array COSArray instance for Indexed color space.
-     * @throws java.io.IOException
+     * @throws IOException if the instance could not be created
      */
     public CSIndexed(COSArray array) throws IOException
     {

Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSSeparation.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSSeparation.java?rev=1905290&r1=1905289&r2=1905290&view=diff
==============================================================================
--- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSSeparation.java (original)
+++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/colorpane/CSSeparation.java Mon Nov 14 07:11:37 2022
@@ -59,7 +59,7 @@ public class CSSeparation implements Cha
      *
      * @param array COSArray instance of the Separation color space.
      * 
-     * @throws java.io.IOException
+     * @throws IOException if the instance could not be created
      */
     public CSSeparation(COSArray array) throws IOException
     {
@@ -194,7 +194,8 @@ public class CSSeparation implements Cha
 
     /**
      * input changed in slider.
-     * @param changeEvent
+     * 
+     * @param changeEvent the event of the change
      */
     @Override
     public void stateChanged(ChangeEvent changeEvent)
@@ -214,7 +215,8 @@ public class CSSeparation implements Cha
 
     /**
      * input changed in text field.
-     * @param actionEvent
+     * 
+     * @param actionEvent the event of the action
      */
     @Override
     public void actionPerformed(ActionEvent actionEvent)

Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/FlagBitsPane.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/FlagBitsPane.java?rev=1905290&r1=1905289&r2=1905290&view=diff
==============================================================================
--- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/FlagBitsPane.java (original)
+++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/flagbitspane/FlagBitsPane.java Mon Nov 14 07:11:37 2022
@@ -34,6 +34,8 @@ public class FlagBitsPane
 
     /**
      * Constructor.
+     * 
+     * @param document the current document
      * @param dictionary COSDictionary instance.
      * @param flagType COSName instance.
      */

Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/treestatus/TreeStatus.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/treestatus/TreeStatus.java?rev=1905290&r1=1905289&r2=1905290&view=diff
==============================================================================
--- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/treestatus/TreeStatus.java (original)
+++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/treestatus/TreeStatus.java Mon Nov 14 07:11:37 2022
@@ -62,7 +62,8 @@ public final class TreeStatus
 
     /**
      * Provides TreePath for a given status string. In case of invalid string returns null.
-     * @param statusString
+     * 
+     * @param statusString the status string of the TreePath
      * @return path.
      */
     public TreePath getPathForString(String statusString)

Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/treestatus/TreeStatusPane.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/treestatus/TreeStatusPane.java?rev=1905290&r1=1905289&r2=1905290&view=diff
==============================================================================
--- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/treestatus/TreeStatusPane.java (original)
+++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/treestatus/TreeStatusPane.java Mon Nov 14 07:11:37 2022
@@ -46,6 +46,8 @@ public class TreeStatusPane implements T
     private Border errorBorder;
     private final Action textInputAction = new AbstractAction()
     {
+        private static final long serialVersionUID = 3547209849264145654L;
+
         @Override
         public void actionPerformed(ActionEvent actionEvent)
         {
@@ -119,7 +121,8 @@ public class TreeStatusPane implements T
 
     /**
      * Tree selection change listener which updates status string.
-     * @param treeSelectionEvent
+     * 
+     * @param treeSelectionEvent the selection event
      */
 
     @Override

Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/PrintDpiMenu.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/PrintDpiMenu.java?rev=1905290&r1=1905289&r2=1905290&view=diff
==============================================================================
--- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/PrintDpiMenu.java (original)
+++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/PrintDpiMenu.java Mon Nov 14 07:11:37 2022
@@ -31,6 +31,7 @@ public final class PrintDpiMenu extends
     @SuppressWarnings("squid:MaximumInheritanceDepth")
     private static class PrintDpiMenuItem extends JRadioButtonMenuItem
     {
+        private static final long serialVersionUID = -475209538362541000L;
         private final int dpi;
 
         PrintDpiMenuItem(String text, int dpi)
@@ -79,7 +80,8 @@ public final class PrintDpiMenu extends
     /**
      * Set the dpi selection.
      *
-     * @param selection
+     * @param selection the selected DPI value
+     * 
      * @throws IllegalArgumentException if the parameter doesn't belong to a dpi menu item.
      */
     public void changeDpiSelection(int selection)

Modified: pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/ViewMenu.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/ViewMenu.java?rev=1905290&r1=1905289&r2=1905290&view=diff
==============================================================================
--- pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/ViewMenu.java (original)
+++ pdfbox/trunk/debugger/src/main/java/org/apache/pdfbox/debugger/ui/ViewMenu.java Mon Nov 14 07:11:37 2022
@@ -130,7 +130,7 @@ public class ViewMenu extends MenuBase
     /**
      * Tell whether the "Extract Text" menu entry was hit.
      *
-     * @param actionEvent
+     * @param actionEvent the action event
      * @return true if the "Extract Text" menu entry was hit.
      */
     public static boolean isExtractTextEvent(ActionEvent actionEvent)
@@ -151,7 +151,7 @@ public class ViewMenu extends MenuBase
     /**
      * Tell whether the "Repair AcroForm" menu entry was hit.
      *
-     * @param actionEvent
+     * @param actionEvent the action event
      * @return true if the "Repair AcroForm" menu entry was hit.
      */
     public static boolean isRepairAcroformEvent(ActionEvent actionEvent)