diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/AbstractCompletion.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/AbstractCompletion.java index fc875d9..d3aa2f5 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/AbstractCompletion.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/AbstractCompletion.java @@ -15,8 +15,8 @@ /** * Base class for possible completions. Most, if not all, {@link Completion} * implementations can extend this class. It remembers the - * CompletionProvider that returns this completion, and also implements - * Comparable, allowing such completions to be compared + * {@code CompletionProvider} that returns this completion, and also implements + * {@code Comparable}, allowing such completions to be compared * lexicographically (ignoring case).

* * This implementation assumes the input text and replacement text are the diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/AbstractCompletionProvider.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/AbstractCompletionProvider.java index 2c70697..2bfd066 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/AbstractCompletionProvider.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/AbstractCompletionProvider.java @@ -58,7 +58,7 @@ public AbstractCompletionProvider() { * * @param c The completion to add. * @throws IllegalArgumentException If the completion's provider isn't - * this CompletionProvider. + * this {@code CompletionProvider}. * @see #addCompletions(List) * @see #removeCompletion(Completion) * @see #clear() @@ -75,7 +75,7 @@ public void addCompletion(Completion c) { * @param completions The completions to add. This cannot be * null. * @throws IllegalArgumentException If a completion's provider isn't - * this CompletionProvider. + * this {@code CompletionProvider}. * @see #addCompletion(Completion) * @see #removeCompletion(Completion) * @see #clear() @@ -114,7 +114,7 @@ protected void checkProviderAndAdd(Completion c) { /** * Removes all completions from this provider. This does not affect - * the parent CompletionProvider, if there is one. + * the parent {@code CompletionProvider}, if there is one. * * @see #addCompletion(Completion) * @see #addCompletions(List) @@ -126,12 +126,12 @@ public void clear() { /** - * Returns a list of Completions in this provider with the + * Returns a list of {@code Completion}s in this provider with the * specified input text. * * @param inputText The input text to search for. * @return A list of {@link Completion}s, or null if there - * are no matching Completions. + * are no matching {@code Completion}s. */ @SuppressWarnings("unchecked") public List getCompletionByInputText(String inputText) { diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/AutoCompletePopupWindow.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/AutoCompletePopupWindow.java index 4fbf613..af5a601 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/AutoCompletePopupWindow.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/AutoCompletePopupWindow.java @@ -819,7 +819,7 @@ private void uninstallKeyBindings() { /** - * Updates the LookAndFeel of this window and the description + * Updates the {@code LookAndFeel} of this window and the description * window. */ public void updateUI() { diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/AutoCompletion.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/AutoCompletion.java index 2950fb1..94366b5 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/AutoCompletion.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/AutoCompletion.java @@ -442,7 +442,7 @@ public ListCellRenderer getParamChoicesRenderer() { * Returns the text to replace with in the document. This is a "last-chance" * hook for subclasses to make special modifications to the completion text * inserted. The default implementation simply returns - * c.getReplacementText(). You usually will not need to modify this + * {@code c.getReplacementText()}. You usually will not need to modify this * method. * * @param c The completion being inserted. diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/BasicCompletion.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/BasicCompletion.java index c9bed83..44d4f45 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/BasicCompletion.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/BasicCompletion.java @@ -130,7 +130,7 @@ public void setSummary(String summary) { * * getInputText() + " - " + shortDesc * - * otherwise, it will return getInputText(). + * otherwise, it will return {@code getInputText()}. * * @return A string representation of this completion. */ diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/Completion.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/Completion.java index 8c93a8a..8f318f3 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/Completion.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/Completion.java @@ -14,7 +14,7 @@ /** * Represents a completion choice. A {@link CompletionProvider} returns lists - * of objects implementing this interface. A Completion contains the + * of objects implementing this interface. A {@code Completion} contains the * following information: * *
    @@ -27,7 +27,7 @@ * can be displayed in a helper "tooltip"-style window beside the * completion list. This may be null. It may also be * lazily generated to cut down on memory usage. - *
  • The CompletionProvider that returned this completion. + *
  • The {@code CompletionProvider} that returned this completion. *
  • Tool tip text that can be displayed when a mouse hovers over this * completion in a text component. *
@@ -137,11 +137,11 @@ public interface Completion extends Comparable { * completion.

* * Note that for this functionality to be enabled, a - * JTextComponent must be registered with the - * ToolTipManager, and the text component must know to search + * {@code JTextComponent} must be registered with the + * {@code ToolTipManager}, and the text component must know to search * for this value. In the case of an * RSyntaxTextArea, this - * can be done with a org.fife.ui.rtextarea.ToolTipSupplier that + * can be done with a {@code org.fife.ui.rtextarea.ToolTipSupplier} that * calls into * {@link CompletionProvider#getCompletionsAt(JTextComponent, java.awt.Point)}. * diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionProvider.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionProvider.java index afc72ee..c3759e7 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionProvider.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionProvider.java @@ -69,7 +69,7 @@ public interface CompletionProvider { * mouse over completed text. * * @param comp The text component. - * @param p The position, usually from a MouseEvent. + * @param p The position, usually from a {@code MouseEvent}. * @return The completions, or an empty list if there are none. */ List getCompletionsAt(JTextComponent comp, Point p); @@ -186,14 +186,14 @@ public interface CompletionProvider { * and methods will not have their parameters auto-completed. * * @param listStart The character that marks the beginning of a list of - * parameters, such as '(' in C or Java. + * parameters, such as '{@code (}' in C or Java. * @param separator Text that should separate parameters in a parameter - * list when one is inserted. For example, ", ". + * list when one is inserted. For example, "{@code , }". * @param listEnd The character that marks the end of a list of parameters, - * such as ')' in C or Java. - * @throws IllegalArgumentException If either listStart or - * listEnd is not printable ASCII, or if - * separator is null or an empty string. + * such as '{@code )}' in C or Java. + * @throws IllegalArgumentException If either {@code listStart} or + * {@code listEnd} is not printable ASCII, or if + * {@code separator} is null or an empty string. * @see #clearParameterizedCompletionParams() */ void setParameterizedCompletionParams(char listStart, diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionProviderBase.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionProviderBase.java index 398c966..80969f8 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionProviderBase.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionProviderBase.java @@ -20,7 +20,7 @@ /** * A base class for all standard completion providers. This class implements - * functionality that should be sharable across all CompletionProvider + * functionality that should be sharable across all {@code CompletionProvider} * implementations. * * @author Robert Futrell diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionXMLParser.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionXMLParser.java index ac75280..2bce880 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionXMLParser.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/CompletionXMLParser.java @@ -71,7 +71,7 @@ public class CompletionXMLParser extends DefaultHandler { /** * If specified in the XML, this class will be used instead of * {@link FunctionCompletion} when appropriate. This class should extend - * FunctionCompletion, or stuff will break. + * {@code FunctionCompletion}, or stuff will break. */ private String funcCompletionType; diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/DefaultCompletionProvider.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/DefaultCompletionProvider.java index 6622625..a7cc965 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/DefaultCompletionProvider.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/DefaultCompletionProvider.java @@ -48,7 +48,7 @@ public class DefaultCompletionProvider extends AbstractCompletionProvider { /** * Used to speed up {@link #getCompletionsAt(JTextComponent, Point)}, * since this may be called multiple times in succession (this is usually - * called by JTextComponent.getToolTipText(), and if the user + * called by {@code JTextComponent.getToolTipText()}, and if the user * wiggles the mouse while a tool tip is displayed, this method gets * repeatedly called. It can be costly so we try to speed it up a tad). */ diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/DelegatingCellRenderer.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/DelegatingCellRenderer.java index 976632e..e0c55dc 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/DelegatingCellRenderer.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/DelegatingCellRenderer.java @@ -29,7 +29,7 @@ class DelegatingCellRenderer extends DefaultListCellRenderer { /** * The renderer to fall back on if one isn't specified by a provider. - * This is usually this. + * This is usually {@code this}. */ private ListCellRenderer fallback; @@ -68,7 +68,7 @@ public Component getListCellRendererComponent(JList list, Object value, * Sets the fallback cell renderer. * * @param fallback The fallback cell renderer. If this is - * null, this will be used. + * null, {@code this} will be used. * @see #getFallbackCellRenderer() */ public void setFallbackCellRenderer(ListCellRenderer fallback) { diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/LanguageAwareCompletionProvider.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/LanguageAwareCompletionProvider.java index c8f6e04..b6cd659 100644 --- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/LanguageAwareCompletionProvider.java +++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/LanguageAwareCompletionProvider.java @@ -39,12 +39,12 @@ * for example.

* * This provider also implements the - * org.fife.ui.rtextarea.ToolTipSupplier interface, which allows it + * {@code org.fife.ui.rtextarea.ToolTipSupplier} interface, which allows it * to display tooltips for completion choices. Thus the standard * {@link VariableCompletion} and {@link FunctionCompletion} completions should * be able to display tooltips with the variable declaration or function - * definition (provided the RSyntaxTextArea was registered with the - * javax.swing.ToolTipManager). + * definition (provided the {@code RSyntaxTextArea} was registered with the + * {@code javax.swing.ToolTipManager}). * * @author Robert Futrell * @version 1.0 @@ -400,8 +400,8 @@ public void setStringCompletionProvider(CompletionProvider provider) { /** * Returns the tool tip to display for a mouse event.

* - * For this method to be called, the RSyntaxTextArea must be - * registered with the javax.swing.ToolTipManager like so: + * For this method to be called, the {@code RSyntaxTextArea} must be + * registered with the {@code javax.swing.ToolTipManager} like so: * *

 	 * ToolTipManager.sharedInstance().registerComponent(textArea);
diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/ParameterizedCompletionChoicesWindow.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/ParameterizedCompletionChoicesWindow.java
index 5ab7fba..7c23d70 100644
--- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/ParameterizedCompletionChoicesWindow.java
+++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/ParameterizedCompletionChoicesWindow.java
@@ -303,7 +303,7 @@ public void setVisible(boolean visible) {
 
 
 	/**
-	 * Updates the LookAndFeel of this window.
+	 * Updates the {@code LookAndFeel} of this window.
 	 */
 	public void updateUI() {
 		SwingUtilities.updateComponentTreeUI(this);
diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/ParameterizedCompletionDescriptionToolTip.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/ParameterizedCompletionDescriptionToolTip.java
index b8c69d5..504f5db 100644
--- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/ParameterizedCompletionDescriptionToolTip.java
+++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/ParameterizedCompletionDescriptionToolTip.java
@@ -236,7 +236,7 @@ public boolean updateText(int selectedParam) {
 
 
 	/**
-	 * Updates the LookAndFeel of this window and the description
+	 * Updates the {@code LookAndFeel} of this window and the description
 	 * window.
 	 */
 	public void updateUI() {
diff --git a/AutoComplete/src/main/java/org/fife/ui/autocomplete/VariableCompletion.java b/AutoComplete/src/main/java/org/fife/ui/autocomplete/VariableCompletion.java
index a068bd1..7402632 100644
--- a/AutoComplete/src/main/java/org/fife/ui/autocomplete/VariableCompletion.java
+++ b/AutoComplete/src/main/java/org/fife/ui/autocomplete/VariableCompletion.java
@@ -14,11 +14,11 @@
 /**
  * A completion for a variable (or constant) in a programming language.

* - * This completion type uses its shortDescription property as part of + * This completion type uses its {@code shortDescription} property as part of * its summary returned by {@link #getSummary()}; for this reason, it may be * a little longer (even much longer), if desired, than what is recommended - * for BasicCompletions (where the shortDescription is used - * in {@link #toString()} for ListCellRenderers). + * for {@code BasicCompletion}s (where the {@code shortDescription} is used + * in {@link #toString()} for {@code ListCellRenderers}). * * @author Robert Futrell * @version 1.0 @@ -112,11 +112,11 @@ public String getSummary() { * completion.

* * Note that for this functionality to be enabled, a - * JTextComponent must be registered with the - * ToolTipManager, and the text component must know to search + * {@code JTextComponent} must be registered with the + * {@code ToolTipManager}, and the text component must know to search * for this value. In the case of an * RSyntaxTextArea, this - * can be done with a org.fife.ui.rtextarea.ToolTipSupplier that + * can be done with a {@code org.fife.ui.rtextarea.ToolTipSupplier} that * calls into * {@link CompletionProvider#getCompletionsAt(JTextComponent, java.awt.Point)}. * diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml index df5d726..2fad508 100644 --- a/config/checkstyle/checkstyle.xml +++ b/config/checkstyle/checkstyle.xml @@ -213,7 +213,7 @@ - + diff --git a/gradle.properties b/gradle.properties index 05489b8..e7b887c 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,3 +1,3 @@ # Note that Maven- and signing-related properties are in /gradle.properties javaVersion=1.8 -version=3.0.5-SNAPSHOT +version=3.0.5