javadoc fix

hironico · Jun 7, 2024 · 47c79d4 · 47c79d4
1 parent a969493
commit 47c79d4
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 18 deletions.
diff --git a/hironico-common/src/main/java/net/hironico/common/swing/ComponentMover.java b/hironico-common/src/main/java/net/hironico/common/swing/ComponentMover.java
@@ -10,18 +10,15 @@
  *  moved can be a high level Window (ie. Window, Frame, Dialog) in which case
  *  the Window is moved within the desktop. Or the Component can belong to a
  *  Container in which case the Component is moved within the Container.
- *
  *  When moving a Window, the listener can be added to a child Component of
  *  the Window. In this case attempting to move the child will result in the
  *  Window moving. For example, you might create a custom "Title Bar" for an
  *  undecorated Window and moving of the Window is accomplished by moving the
  *  title bar only. Multiple components can be registered as "window movers".
- *
  *  Components can be registered when the class is created. Additional
  *  components can be added at any time using the registerComponent() method.
- *
  *  Source:
- *  http://www.camick.com/java/source/ComponentMover.java
+ *  <a href="http://www.camick.com/java/source/ComponentMover.java">...</a>
  */
 public class ComponentMover extends MouseAdapter
 {
@@ -58,7 +55,7 @@ public ComponentMover()
      *  will be passed to the first ancestor of this specified class.
      *
      *  @param destinationClass  the Class of the ancestor component
-     *  @param component         the Components to be registered for forwarding
+     *  @param components         the Components to be registered for forwarding
      *                           drag events to the ancestor Component.
      */
     public ComponentMover(Class destinationClass, Component... components)
@@ -171,7 +168,7 @@ public void setEdgeInsets(Insets edgeInsets)
     /**
      *  Remove listeners from the specified component
      *
-     *  @param component  the component the listeners are removed from
+     *  @param components  the component the listeners are removed from
      */
     public void deregisterComponent(Component... components)
     {
@@ -182,7 +179,7 @@ public void deregisterComponent(Component... components)
     /**
      *  Add the required listeners to the specified component
      *
-     *  @param component  the component the listeners are added to
+     *  @param components  the component the listeners are added to
      */
     public void registerComponent(Component... components)
     {

diff --git a/hironico-common/src/main/java/net/hironico/common/swing/ComponentResizer.java b/hironico-common/src/main/java/net/hironico/common/swing/ComponentResizer.java
@@ -9,8 +9,7 @@
 /**
  *  The ComponentResizer allows you to resize a component by dragging a border
  *  of the component.
- *  Source :
- *  http://www.camick.com/java/source/ComponentResizer.java
+ *  Source : http://www.camick.com/java/source/ComponentResizer.java
  */
 public class ComponentResizer extends MouseAdapter
 {
@@ -170,9 +169,8 @@ public void setMinimumSize(Dimension minimumSize)
     }
 
     /**
-     *  Remove listeners from the specified component
-     *
-     *  @param component  the component the listeners are removed from
+     *  Remove listeners from the specified components
+     *  @param components the components to remove the listener from
      */
     public void deregisterComponent(Component... components)
     {
@@ -184,9 +182,8 @@ public void deregisterComponent(Component... components)
     }
 
     /**
-     *  Add the required listeners to the specified component
-     *
-     *  @param component  the component the listeners are added to
+     *  Add the required listeners to the specified components
+     * @param components the components to remove the listener from
      */
     public void registerComponent(Component... components)
     {

diff --git a/hironico-common/src/main/java/net/hironico/common/utils/NicoCrypto.java b/hironico-common/src/main/java/net/hironico/common/utils/NicoCrypto.java
@@ -36,7 +36,7 @@ public NicoCrypto() {
     }
 
     /**
-     * Loads a text file with Base&ç key data then returns a SecretKey object initialized withi this key.
+     * Loads a text file with Base key data then returns a SecretKey object initialized with this key.
      */
     public static SecretKey load(File keyFile) throws Exception {
         if (keyFile == null || !keyFile.exists()) {

diff --git a/hironico-minisql/src/main/java/net/hironico/minisql/ui/visualdb/DBGraphScene.java b/hironico-minisql/src/main/java/net/hironico/minisql/ui/visualdb/DBGraphScene.java
@@ -58,7 +58,7 @@ public DBGraphScene() {
     /**
      * Fournit un accès en lecture à la liste des tables qui sont actuellement
      * en cours d'édition dans cette scène.
-     * @return List<SQLTable> liste des tables affichées.
+     * @return liste des tables affichées.
      * @since 2.1.0
      */
     public List<SQLTable> getDisplayedTableList() {

diff --git a/hironico-minisql/src/main/java/net/hironico/minisql/utils/DbUtils.java b/hironico-minisql/src/main/java/net/hironico/minisql/utils/DbUtils.java
@@ -53,7 +53,7 @@ public static String getJsonResultSet(DbConfig dbConfig, String sql) throws SQLE
      * @param dbConfig the config to connect to
      * @param sql the common to get result from
      * @param propSeparator used to split properties (aka key value pairs)
-     * @param,kvSeparator used to split key and value for each property
+     * @param kvSeparator used to split key and value for each property
      * @return list of mapped properties to a column
      * @throws Exception in case of any problem
      */