From 143fa2bf8f2c73babc346cf653842009a11cd254 Mon Sep 17 00:00:00 2001 From: pdbro2k <40125493+pdbro2k@users.noreply.github.com> Date: Wed, 22 Nov 2023 13:10:47 +0100 Subject: [PATCH] fixed JavaDocs --- .../askmore/factories/BasicInputFieldFactory.java | 4 ++-- .../da/extensions/askmore/models/SelectableOption.java | 2 +- .../da/extensions/askmore/utils/APIAccessUtils.java | 6 +++--- .../askmore/utils/AskMoreAnnotationParser.java | 2 +- .../da/extensions/askmore/utils/InputDialogUtils.java | 2 +- .../adwmainz/da/extensions/askmore/utils/XMLUtils.java | 4 ++-- .../da/extensions/askmore/views/BasicInputDialog.java | 4 ++-- .../askmore/views/SingleSelectionDialog.java | 10 +++++----- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/src/main/java/org/adwmainz/da/extensions/askmore/factories/BasicInputFieldFactory.java b/src/main/java/org/adwmainz/da/extensions/askmore/factories/BasicInputFieldFactory.java index 5f8830e..ebdbadf 100644 --- a/src/main/java/org/adwmainz/da/extensions/askmore/factories/BasicInputFieldFactory.java +++ b/src/main/java/org/adwmainz/da/extensions/askmore/factories/BasicInputFieldFactory.java @@ -20,9 +20,9 @@ public class BasicInputFieldFactory { * Creates a subclass of a BasicOnputField that matches the following params * @param defaultValue a value that should be displayed on the created input field per default * @param options a set of options that should be selectable in the created input field - *
(a basic text input field will be created if the set is empty or null) + *
(a basic text input field will be created if the set is empty or null) * @param isEditable specifies whether the set of options should be editable or not - *
(will be ignored if there are no options) + *
(will be ignored if there are no options) * @param inputVerifiers a set of input verifiers that should be added to the input field */ public static BasicInputField createInputField(String defaultValue, Set> options, boolean isEditable, diff --git a/src/main/java/org/adwmainz/da/extensions/askmore/models/SelectableOption.java b/src/main/java/org/adwmainz/da/extensions/askmore/models/SelectableOption.java index 06fe0fd..e281f8e 100644 --- a/src/main/java/org/adwmainz/da/extensions/askmore/models/SelectableOption.java +++ b/src/main/java/org/adwmainz/da/extensions/askmore/models/SelectableOption.java @@ -17,7 +17,7 @@ public class SelectableOption implements Comparable> { /** * Creates a new SelectableOption that does not differentiate between a real and a rendered value * @param realValue the real value of this SelectionOption - *
(the rendered value will be generated using its toString() method) + *
(the rendered value will be generated using its toString() method) */ public SelectableOption(T realValue) { this.realValue = realValue; diff --git a/src/main/java/org/adwmainz/da/extensions/askmore/utils/APIAccessUtils.java b/src/main/java/org/adwmainz/da/extensions/askmore/utils/APIAccessUtils.java index 766d7cb..01522c2 100644 --- a/src/main/java/org/adwmainz/da/extensions/askmore/utils/APIAccessUtils.java +++ b/src/main/java/org/adwmainz/da/extensions/askmore/utils/APIAccessUtils.java @@ -78,7 +78,7 @@ public static String[] getSeverityNames() { /** * Returns the int representation of the specified severity * @param severityName the name of a severity - *
The allowed values are: Info, Warning, Error and Fatal + *
The allowed values are: Info, Warning, Error and Fatal * @throws IllegalArgumentException if severityName is not one of the mentioned values */ public static int getSeverity(String severityName) throws IllegalArgumentException { @@ -97,7 +97,7 @@ public static int getSeverity(String severityName) throws IllegalArgumentExcepti } /** - * Returns a serialized form of XPath results (i.e. serialized XML if the result type is node() and plain text otherwise) + * Returns a serialized form of XPath results (i.e. serialized XML if the result type is node() and plain text otherwise) * @param documentController the current AuthorDocumentController * @param xPathExpression an XPath expression * @throws AuthorOperationException if the xPathExpression is invalid or the results cannot be serialized @@ -109,7 +109,7 @@ public static List getSerializedXPathResults(AuthorDocumentController do } /** - * Returns a serialized form of XPath results (i.e. serialized XML if the result type is node() and plain text otherwise) relative to a given context node + * Returns a serialized form of XPath results (i.e. serialized XML if the result type is node() and plain text otherwise) relative to a given context node * @param documentController the current AuthorDocumentController * @param contextNode the context node to be used to evaluate the XPath expression * @param xPathExpression an XPath expression diff --git a/src/main/java/org/adwmainz/da/extensions/askmore/utils/AskMoreAnnotationParser.java b/src/main/java/org/adwmainz/da/extensions/askmore/utils/AskMoreAnnotationParser.java index dc74424..352f64c 100644 --- a/src/main/java/org/adwmainz/da/extensions/askmore/utils/AskMoreAnnotationParser.java +++ b/src/main/java/org/adwmainz/da/extensions/askmore/utils/AskMoreAnnotationParser.java @@ -107,7 +107,7 @@ else if (flag.matches(IS_EDITABLE_PATTERN)) /** * Creates a subclass of a VerboseInputVerifier from a specified flag * @param flag a flag representing a specific subclass of a VerboseInputVerifier - *
The allowed values are: !REGEX("regex"), !NO_XML, !NO_SPACE and !POS_INT + *
The allowed values are: !REGEX("regex"), !NO_XML, !NO_SPACE and !POS_INT * @return * @throws IllegalArgumentException */ diff --git a/src/main/java/org/adwmainz/da/extensions/askmore/utils/InputDialogUtils.java b/src/main/java/org/adwmainz/da/extensions/askmore/utils/InputDialogUtils.java index b91046b..2dd4250 100644 --- a/src/main/java/org/adwmainz/da/extensions/askmore/utils/InputDialogUtils.java +++ b/src/main/java/org/adwmainz/da/extensions/askmore/utils/InputDialogUtils.java @@ -127,7 +127,7 @@ public static String replaceAnnotationsWithUserInput(String annotatedText) throw /** * Returns the int representation of the specified severity * @param severityName the name of a severity - *
The allowed values are: Info, Warning, Error and Fatal + *
The allowed values are: Info, Warning, Error and Fatal * @throws IllegalArgumentException if severityName is not one of the mentioned values */ public static int getMessageType(String severityName) throws IllegalArgumentException { diff --git a/src/main/java/org/adwmainz/da/extensions/askmore/utils/XMLUtils.java b/src/main/java/org/adwmainz/da/extensions/askmore/utils/XMLUtils.java index 5a3d346..8602a6f 100644 --- a/src/main/java/org/adwmainz/da/extensions/askmore/utils/XMLUtils.java +++ b/src/main/java/org/adwmainz/da/extensions/askmore/utils/XMLUtils.java @@ -9,14 +9,14 @@ public class XMLUtils { /** - * Returns an array of all XML special chars (i.e. &, <, >, ', ") + * Returns an array of all XML special chars (i.e. &, <, >, ', ") */ public static char[] getSpecialChars() { return new char[] {'&', '<', '>', '\'', '"'}; } /** - * Returns a String in which all XML special chars (&, <, >, ', ") are replaced by their escaped + * Returns a String in which all XML special chars (&, <, >, ', ") are replaced by their escaped * references (e.g. &) * @param str a String with unescaped xml special chars */ diff --git a/src/main/java/org/adwmainz/da/extensions/askmore/views/BasicInputDialog.java b/src/main/java/org/adwmainz/da/extensions/askmore/views/BasicInputDialog.java index 6bc3047..2a890bc 100644 --- a/src/main/java/org/adwmainz/da/extensions/askmore/views/BasicInputDialog.java +++ b/src/main/java/org/adwmainz/da/extensions/askmore/views/BasicInputDialog.java @@ -110,7 +110,7 @@ public BasicInputDialog(Window owner, boolean isModal, Alignment horizontalFormG /** * Changes the text displayed on the OK button - *

Must be invoked before the method initComponents() is invoked + *
Must be invoked before the method initComponents() is invoked * @param okButtonText */ public void setOkButtonText(String okButtonText) { @@ -119,7 +119,7 @@ public void setOkButtonText(String okButtonText) { /** * Changes the text displayed on the CANCEL button - *

Must be invoked before the method initComponents() is invoked + *
Must be invoked before the method initComponents() is invoked * @param cancelButtonText */ public void setCancelBtnTxt(String cancelButtonText) { diff --git a/src/main/java/org/adwmainz/da/extensions/askmore/views/SingleSelectionDialog.java b/src/main/java/org/adwmainz/da/extensions/askmore/views/SingleSelectionDialog.java index df2891d..4dac73c 100644 --- a/src/main/java/org/adwmainz/da/extensions/askmore/views/SingleSelectionDialog.java +++ b/src/main/java/org/adwmainz/da/extensions/askmore/views/SingleSelectionDialog.java @@ -33,7 +33,7 @@ public class SingleSelectionDialog extends BasicInputDialog { /** * Creates a new SingleSelectionDialog with the specified params and a default alignment (i.e. the selection form control is aligned to the left with a * vertical alignment set to Alignment.BASELINE while the main buttons (OK/CANCEL) are aligned to the right). - *

Please use the setLabelText() method to add a label + *
Please use the setLabelText() method to add a label * @param owner the Frame from which the dialog is displayed * @param isModal specifies whether the dialog blocks user input to other top-level windows when shown * @param options a list of options that should be selectable @@ -45,7 +45,7 @@ public SingleSelectionDialog(Window owner, boolean isModal, Set options) { /** * Creates a new SingleSelectionDialog with the specified params - *

Please use the setLabelText() method to add a label + *
Please use the setLabelText() method to add a label * @param owner the Frame from which the dialog is displayed * @param isModal specifies whether the dialog blocks user input to other top-level windows when shown * @param horizontalAlignment specifies the horizontal alignment of the selection form control. Use Alignment.LEADING to left indent, @@ -62,7 +62,7 @@ public SingleSelectionDialog(Window owner, boolean isModal, Alignment horizontal /** * Creates a new SingleSelectionDialog with the specified params - *

Please use the setLabelText() method to add a label + *
Please use the setLabelText() method to add a label * @param owner the Frame from which the dialog is displayed * @param isModal specifies whether the dialog blocks user input to other top-level windows when shown * @param horizontalFormGroupAlignment specifies the horizontal alignment of the selection form control. Use Alignment.LEADING to left indent, @@ -90,7 +90,7 @@ public T getUserInput() throws InputDialogClosedException { // other overridden methods /** * Initializes all components and positions them - *

Use addLabel() before invoking this method to add a label to this dialog + *
Use addLabel() before invoking this method to add a label to this dialog */ @Override public void initComponents() { @@ -124,7 +124,7 @@ protected void okButtonActionPerformed(ActionEvent event) { // additional method /** * Adds a label with the specified text next to the selection form control - *

Must be invoked before the method initComponents() is invoked + *
Must be invoked before the method initComponents() is invoked * @param labelText the text that should displayed on the label next to the selection form control */ public void addLabel(String labelText) {