supplemental: add javadoc for serialVersionUID fields (checkstyle#10818)

singhbaljit · Sep 25, 2021 · 25c3842 · 25c3842
1 parent 0b7cfd0
commit 25c3842
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 0 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/DefaultConfiguration.java b/src/main/java/com/puppycrawl/tools/checkstyle/DefaultConfiguration.java
@@ -36,6 +36,7 @@
  */
 public final class DefaultConfiguration implements Configuration {
 
+    /** A unique serial version identifier. */
     private static final long serialVersionUID = 1157875385356127169L;
 
     /** Constant for optimization. */

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/ThreadModeSettings.java b/src/main/java/com/puppycrawl/tools/checkstyle/ThreadModeSettings.java
@@ -46,6 +46,7 @@ public class ThreadModeSettings implements Serializable {
     public static final ThreadModeSettings SINGLE_THREAD_MODE_INSTANCE =
             new ThreadModeSettings(1, 1);
 
+    /** A unique serial version identifier. */
     private static final long serialVersionUID = 1L;
 
     /** The checker threads number. */

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/Violation.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/Violation.java
@@ -48,6 +48,7 @@
 public final class Violation
     implements Comparable<Violation>, Serializable {
 
+    /** A unique serial version identifier. */
     private static final long serialVersionUID = 5675176836184862150L;
 
     /**

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/OrderedPropertiesCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/OrderedPropertiesCheck.java
@@ -217,6 +217,7 @@ private static Pattern getKeyPattern(String keyName) {
      */
     private static class SequencedProperties extends Properties {
 
+        /** A unique serial version identifier. */
         private static final long serialVersionUID = 1L;
 
         /**

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/UniquePropertiesCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/UniquePropertiesCheck.java
@@ -201,6 +201,7 @@ private static Pattern getKeyPattern(String keyName) {
      */
     private static class UniqueProperties extends Properties {
 
+        /** A unique serial version identifier. */
         private static final long serialVersionUID = 1L;
         /**
          * Map, holding duplicated keys and their count. Keys are added here only if they

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/gui/ListToTreeSelectionModelWrapper.java b/src/main/java/com/puppycrawl/tools/checkstyle/gui/ListToTreeSelectionModelWrapper.java
@@ -32,6 +32,7 @@
  */
 class ListToTreeSelectionModelWrapper extends DefaultTreeSelectionModel {
 
+    /** A unique serial version identifier. */
     private static final long serialVersionUID = 2267930983939339510L;
     /** TreeTable to perform updates on. */
     private final TreeTable treeTable;

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/gui/MainFrame.java b/src/main/java/com/puppycrawl/tools/checkstyle/gui/MainFrame.java
@@ -54,6 +54,7 @@
  */
 public class MainFrame extends JFrame {
 
+    /** A unique serial version identifier. */
     private static final long serialVersionUID = 7970053543351871890L;
 
     /** Checkstyle frame model. */
@@ -202,6 +203,7 @@ public void openFile(File sourceFile) {
      */
     private class FileSelectionAction extends AbstractAction {
 
+        /** A unique serial version identifier. */
         private static final long serialVersionUID = 1762396148873280589L;
 
         @Override
@@ -224,6 +226,7 @@ public void actionPerformed(ActionEvent event) {
      */
     private class ReloadAction extends AbstractAction {
 
+        /** A unique serial version identifier. */
         private static final long serialVersionUID = -890320994114628011L;
 
         @Override
@@ -238,6 +241,7 @@ public void actionPerformed(ActionEvent event) {
      */
     private class ExpandCollapseAction extends AbstractAction {
 
+        /** A unique serial version identifier. */
         private static final long serialVersionUID = -890320994114628011L;
 
         @Override
@@ -252,6 +256,7 @@ public void actionPerformed(ActionEvent event) {
      */
     private class FindNodeByXpathAction extends AbstractAction {
 
+        /** A unique serial version identifier. */
         private static final long serialVersionUID = -890320994114628011L;
 
         @Override

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTable.java b/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTable.java
@@ -57,6 +57,7 @@
  */
 public final class TreeTable extends JTable {
 
+    /** A unique serial version identifier. */
     private static final long serialVersionUID = -8493693409423365387L;
     /** A subclass of JTree. */
     private final TreeTableCellRenderer tree;

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTableModelAdapter.java b/src/main/java/com/puppycrawl/tools/checkstyle/gui/TreeTableModelAdapter.java
@@ -41,6 +41,7 @@
  */
 public class TreeTableModelAdapter extends AbstractTableModel {
 
+    /** A unique serial version identifier. */
     private static final long serialVersionUID = 8269213416115369275L;
 
     /** JTree component. */
-Original file line number
+Diff line change
@@ Expand Up / @@ -217,6 +217,7 @@ private static Pattern getKeyPattern(String keyName) { @@
          */
         private static class SequencedProperties extends Properties {
+            /** A unique serial version identifier. */
             private static final long serialVersionUID = 1L;
             /**
@@ Expand Down @@