Skip to content

Commit

Permalink
fixed JavaDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
pdbro2k committed Nov 22, 2023
1 parent 513e41c commit 143fa2b
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <br/>(a basic text input field will be created if the set is empty or <code>null</code>)
* <br>(a basic text input field will be created if the set is empty or <code>null</code>)
* @param isEditable specifies whether the set of options should be editable or not
* <br/>(will be ignored if there are no options)
* <br>(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<String> createInputField(String defaultValue, Set<SelectableOption<String>> options, boolean isEditable,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public class SelectableOption<T> implements Comparable<SelectableOption<T>> {
/**
* Creates a new SelectableOption that does not differentiate between a real and a rendered value
* @param realValue the real value of this SelectionOption
* <br/>(the rendered value will be generated using its <code>toString()</code> method)
* <br>(the rendered value will be generated using its <code>toString()</code> method)
*/
public SelectableOption(T realValue) {
this.realValue = realValue;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public static String[] getSeverityNames() {
/**
* Returns the int representation of the specified severity
* @param severityName the name of a severity
* <br />The allowed values are: <code>Info</code>, <code>Warning</code>, <code>Error</code> and <code>Fatal</code>
* <br>The allowed values are: <code>Info</code>, <code>Warning</code>, <code>Error</code> and <code>Fatal</code>
* @throws IllegalArgumentException if <code>severityName</code> is not one of the mentioned values
*/
public static int getSeverity(String severityName) throws IllegalArgumentException {
Expand All @@ -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 <code>node()</node> and plain text otherwise)
* Returns a serialized form of XPath results (i.e. serialized XML if the result type is <code>node()</code> 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
Expand All @@ -109,7 +109,7 @@ public static List<String> getSerializedXPathResults(AuthorDocumentController do
}

/**
* Returns a serialized form of XPath results (i.e. serialized XML if the result type is <code>node()</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 <code>node()</code> 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <br />The allowed values are: <code>!REGEX("regex")</code>, <code>!NO_XML</code>, <code>!NO_SPACE</code> and <code>!POS_INT</code>
* <br>The allowed values are: <code>!REGEX("regex")</code>, <code>!NO_XML</code>, <code>!NO_SPACE</code> and <code>!POS_INT</code>
* @return
* @throws IllegalArgumentException
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <br />The allowed values are: <code>Info</code>, <code>Warning</code>, <code>Error</code> and <code>Fatal</code>
* <br>The allowed values are: <code>Info</code>, <code>Warning</code>, <code>Error</code> and <code>Fatal</code>
* @throws IllegalArgumentException if <code>severityName</code> is not one of the mentioned values
*/
public static int getMessageType(String severityName) throws IllegalArgumentException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. &amp;, &lt;, &gt;, ', ")
*/
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 (&amp;, &lt;, &gt;, ', ") are replaced by their escaped
* references (e.g. <code>&amp;</code>)
* @param str a String with unescaped xml special chars
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public BasicInputDialog(Window owner, boolean isModal, Alignment horizontalFormG

/**
* Changes the text displayed on the OK button
* <br /></br />Must be invoked before the method <code>initComponents()</code> is invoked
* <br>Must be invoked before the method <code>initComponents()</code> is invoked
* @param okButtonText
*/
public void setOkButtonText(String okButtonText) {
Expand All @@ -119,7 +119,7 @@ public void setOkButtonText(String okButtonText) {

/**
* Changes the text displayed on the CANCEL button
* <br /></br />Must be invoked before the method <code>initComponents()</code> is invoked
* <br>Must be invoked before the method <code>initComponents()</code> is invoked
* @param cancelButtonText
*/
public void setCancelBtnTxt(String cancelButtonText) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public class SingleSelectionDialog<T> extends BasicInputDialog<T> {
/**
* 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 <code>Alignment.BASELINE</code> while the main buttons (OK/CANCEL) are aligned to the right).
* <br/><br/>Please use the <code>setLabelText()</code> method to add a label
* <br>Please use the <code>setLabelText()</code> 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
Expand All @@ -45,7 +45,7 @@ public SingleSelectionDialog(Window owner, boolean isModal, Set<T> options) {

/**
* Creates a new SingleSelectionDialog with the specified params
* <br/><br/>Please use the <code>setLabelText()</code> method to add a label
* <br>Please use the <code>setLabelText()</code> 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 <code>Alignment.LEADING</code> to left indent,
Expand All @@ -62,7 +62,7 @@ public SingleSelectionDialog(Window owner, boolean isModal, Alignment horizontal

/**
* Creates a new SingleSelectionDialog with the specified params
* <br/><br/>Please use the <code>setLabelText()</code> method to add a label
* <br>Please use the <code>setLabelText()</code> 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 <code>Alignment.LEADING</code> to left indent,
Expand Down Expand Up @@ -90,7 +90,7 @@ public T getUserInput() throws InputDialogClosedException {
// other overridden methods
/**
* Initializes all components and positions them
* <br /><br />Use <code>addLabel()</code> before invoking this method to add a label to this dialog
* <br>Use <code>addLabel()</code> before invoking this method to add a label to this dialog
*/
@Override
public void initComponents() {
Expand Down Expand Up @@ -124,7 +124,7 @@ protected void okButtonActionPerformed(ActionEvent event) {
// additional method
/**
* Adds a label with the specified text next to the selection form control
* <br /></br />Must be invoked before the method <code>initComponents()</code> is invoked
* <br>Must be invoked before the method <code>initComponents()</code> is invoked
* @param labelText the text that should displayed on the label next to the selection form control
*/
public void addLabel(String labelText) {
Expand Down

0 comments on commit 143fa2b

Please sign in to comment.