[Codeathon]Fix errors on javadoc generation on app-eslog ControlSyste…

…mStudio#2795
JonasDevelops · Sep 4, 2023 · 51f59c9 · 51f59c9
1 parent fae2843
commit 51f59c9
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 12 deletions.
diff --git a/...eslog/src/main/java/org/phoebus/applications/eslog/archivedjmslog/ElasticsearchModel.java b/...eslog/src/main/java/org/phoebus/applications/eslog/archivedjmslog/ElasticsearchModel.java
@@ -39,7 +39,7 @@
  * Default filtering is by time stamp. It is assumed that the used index
  * includes a field of type date that represents this time stamp.
  *
- * @author Michael Ritzert <michael.ritzert@ziti.uni-heidelberg.de>
+ * @author Michael Ritzert {@literal <michael.ritzert@ziti.uni-heidelberg.de>}
  */
 public class ElasticsearchModel<T extends LogMessage> extends ArchiveModel<T>
 {

diff --git a/app/eslog/src/main/java/org/phoebus/applications/eslog/archivedjmslog/JMSReceiver.java b/app/eslog/src/main/java/org/phoebus/applications/eslog/archivedjmslog/JMSReceiver.java
@@ -66,10 +66,6 @@ public class JMSReceiver
      *            JMS user name or <code>null</code>
      * @param password
      *            JMS password or <code>null</code>
-     * @param topic_names
-     *            JMS topics, separated by comma
-     * @throws Exception
-     *             on error
      */
     public JMSReceiver(final String url, final String user,
             final String password)

diff --git a/app/eslog/src/main/java/org/phoebus/applications/eslog/archivedjmslog/MergedModel.java b/app/eslog/src/main/java/org/phoebus/applications/eslog/archivedjmslog/MergedModel.java
@@ -228,7 +228,7 @@ public void setFilters(PropertyFilter[] filters)
      * @param start_spec
      *            The start time.
      * @param end_spec
-     *            The end time. Set to {@value RelativeTime#NOW} to enable the
+     *            The end time. Set to value RelativeTime#NOW to enable the
      *            reception of live messages via JMS.
      */
     public void setTimerange(final String start_spec, final String end_spec)

diff --git a/app/eslog/src/main/java/org/phoebus/applications/eslog/archivedjmslog/PropertyFilter.java b/app/eslog/src/main/java/org/phoebus/applications/eslog/archivedjmslog/PropertyFilter.java
@@ -34,7 +34,7 @@ public boolean match(LogMessage msg)
      *
      * The inversion is already considered in the result of
      * {@link PropertyFilter#match(LogMessage)} and
-     * {@link PropertyFilter#match(Function).
+     * {@link PropertyFilter#match(Function)}.
      *
      * @return The value of the inverted property.
      */

diff --git a/...pp/src/main/java/org/phoebus/applications/saveandrestore/ui/ContextMenuCreateSaveset.java b/...pp/src/main/java/org/phoebus/applications/saveandrestore/ui/ContextMenuCreateSaveset.java
@@ -50,7 +50,7 @@
  *  Provide a context menu item for creating or adding to a saveset
  *  from the selection of {@link ProcessVariable}s.
  *
- *  @author Genie Jhang <changj@frib.msu.edu>
+ *  @author Genie Jhang {@literal <changj@frib.msu.edu>}
  */
 @SuppressWarnings("nls")
 public class ContextMenuCreateSaveset implements ContextMenuEntry

diff --git a/...pp/src/main/java/org/phoebus/applications/saveandrestore/ui/SaveAndRestoreController.java b/...pp/src/main/java/org/phoebus/applications/saveandrestore/ui/SaveAndRestoreController.java
@@ -105,7 +105,7 @@
 import java.util.stream.Collectors;
 
 /**
- * Main controller for the save & restore UI.
+ * Main controller for the save and restore UI.
  */
 public class SaveAndRestoreController implements Initializable, NodeChangedListener, NodeAddedListener, FilterChangeListener {
 
@@ -1166,7 +1166,7 @@ private void removeMovedNodes(TreeItem<Node> parentTreeItem, List<Node> nodes) {
     }
 
     /**
-     * Launches the save & restore app and highlights/loads the "resource" (configuration or snapshot) identified
+     * Launches the save and restore app and highlights/loads the "resource" (configuration or snapshot) identified
      * by the {@link URI}. If the configuration/snapshot in question cannot be found, an error dialog is shown.
      *
      * @param uri An {@link URI} on the form file:/unique-id?app=saveandrestore, where unique-id is the

diff --git a/...ore/app/src/main/java/org/phoebus/applications/saveandrestore/ui/TagProposalProvider.java b/...ore/app/src/main/java/org/phoebus/applications/saveandrestore/ui/TagProposalProvider.java
@@ -29,7 +29,7 @@
 import java.util.logging.Logger;
 
 /**
- * {@link ProposalProvider} offering proposals based on existing save & restore tag names.
+ * {@link ProposalProvider} offering proposals based on existing save and restore tag names.
  */
 public class TagProposalProvider implements ProposalProvider {
 

diff --git a/...re/app/src/main/java/org/phoebus/applications/saveandrestore/ui/snapshot/tag/TagUtil.java b/...re/app/src/main/java/org/phoebus/applications/saveandrestore/ui/snapshot/tag/TagUtil.java
@@ -59,7 +59,7 @@
 /**
  * {@link TagUtil} class provides rich information header of {@link Tag} as {@link Node}
  *
- * @author Genie Jhang <changj@frib.msu.edu>
+ * @author Genie Jhang {@literal <changj@frib.msu.edu>}
  */
 
 public class TagUtil {