KeyEvent class, without
* the VK_ prefix.
* @param keyStroke A string description of the key stroke
+ * @return The KeyStroke object associated with the input string
*/
public static KeyStroke parseKeyStroke(String keyStroke)
{
diff --git a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/InputHandler.java b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/InputHandler.java
index c6d3d4d6..e492c623 100644
--- a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/InputHandler.java
+++ b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/InputHandler.java
@@ -175,7 +175,7 @@ public abstract class InputHandler extends KeyAdapter
}
/**
- * Returns a named text area action.
+ * @return a named text area action.
* @param name The action name
*/
public static ActionListener getAction(String name)
@@ -184,7 +184,7 @@ public static ActionListener getAction(String name)
}
/**
- * Returns the name of the specified text area action.
+ * @return the name of the specified text area action.
* @param listener The action listener
*/
public static String getActionName(ActionListener listener)
@@ -201,7 +201,7 @@ public static String getActionName(ActionListener listener)
}
/**
- * Returns an enumeration of all available actions.
+ * @return an enumeration of all available actions.
*/
public static Enumeration getActions()
{
@@ -246,7 +246,7 @@ public void grabNextKeyStroke(ActionListener listener)
}
/**
- * Returns if repeating is enabled. When repeating is enabled,
+ * @return if repeating is enabled. When repeating is enabled,
* actions will be executed multiple times. This is usually
* invoked with a special key stroke in the input handler.
*/
@@ -259,6 +259,7 @@ public boolean isRepeatEnabled()
* Enables repeating. When repeating is enabled, actions will be
* executed multiple times. Once repeating is enabled, the input
* handler should read a number from the keyboard.
+ * @param repeat true enables repeating
*/
public void setRepeatEnabled(boolean repeat)
{
@@ -266,7 +267,7 @@ public void setRepeatEnabled(boolean repeat)
}
/**
- * Returns the number of times the next action will be repeated.
+ * @return the number of times the next action will be repeated.
*/
public int getRepeatCount()
{
@@ -283,7 +284,7 @@ public void setRepeatCount(int repeatCount)
}
/**
- * Returns the macro recorder. If this is non-null, all executed
+ * @return the macro recorder. If this is non-null, all executed
* actions should be forwarded to the recorder.
*/
public InputHandler.MacroRecorder getMacroRecorder()
@@ -302,7 +303,7 @@ public void setMacroRecorder(InputHandler.MacroRecorder recorder)
}
/**
- * Returns a copy of this input handler that shares the same
+ * @return a copy of this input handler that shares the same
* key bindings. Setting key bindings in the copy will also
* set them in the original.
*/
@@ -370,7 +371,7 @@ public void executeAction(ActionListener listener, Object source,
}
/**
- * Returns the text area that fired the specified event.
+ * @return the text area that fired the specified event.
* @param evt The event
*/
public static JEditTextArea getTextArea(EventObject evt)
diff --git a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/JEditTextArea.java b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/JEditTextArea.java
index d106ce84..5489dac6 100644
--- a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/JEditTextArea.java
+++ b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/JEditTextArea.java
@@ -156,7 +156,7 @@ public JEditTextArea(TextAreaDefaults defaults)
}
/**
- * Returns if this component can be traversed by pressing
+ * @return if this component can be traversed by pressing
* the Tab key. This returns false.
*/
public final boolean isFocusable()
@@ -165,7 +165,7 @@ public final boolean isFocusable()
}
/**
- * Returns the object responsible for painting this text area.
+ * @return the object responsible for painting this text area.
*/
public final TextAreaPainter getPainter()
{
@@ -173,7 +173,7 @@ public final TextAreaPainter getPainter()
}
/**
- * Returns the input handler.
+ * @return the input handler.
*/
public final InputHandler getInputHandler()
{
@@ -190,7 +190,7 @@ public void setInputHandler(InputHandler inputHandler)
}
/**
- * Returns true if the caret is blinking, false otherwise.
+ * @return true if the caret is blinking, false otherwise.
*/
public final boolean isCaretBlinkEnabled()
{
@@ -211,7 +211,7 @@ public void setCaretBlinkEnabled(boolean caretBlinks)
}
/**
- * Returns true if the caret is visible, false otherwise.
+ * @return true if the caret is visible, false otherwise.
*/
public final boolean isCaretVisible()
{
@@ -246,7 +246,7 @@ public final void blinkCaret()
}
/**
- * Returns the number of lines from the top and button of the
+ * @return the number of lines from the top and button of the
* text area that are always visible.
*/
public final int getElectricScroll()
@@ -290,7 +290,7 @@ public void updateScrollBars()
}
/**
- * Returns the line displayed at the text area's origin.
+ * @return the line displayed at the text area's origin.
*/
public final int getFirstLine()
{
@@ -300,6 +300,7 @@ public final int getFirstLine()
/**
* Sets the line displayed at the text area's origin without
* updating the scroll bars.
+ * @param firstLine The position of the first line in lines
*/
public void setFirstLine(int firstLine)
{
@@ -312,7 +313,7 @@ public void setFirstLine(int firstLine)
}
/**
- * Returns the number of lines visible in this text area.
+ * @return the number of lines visible in this text area.
*/
public final int getVisibleLines()
{
@@ -334,7 +335,7 @@ public final void recalculateVisibleLines()
}
/**
- * Returns the horizontal offset of drawn lines.
+ * @return the horizontal offset of drawn lines.
*/
public final int getHorizontalOffset()
{
@@ -456,8 +457,9 @@ else if(x + width >= painter.getWidth())
}
/**
- * Converts a line index to a y co-ordinate.
+ * Converts a line index to a y coordinate.
* @param line The line
+ * @return The y coordinate
*/
public int lineToY(int line)
{
@@ -473,8 +475,9 @@ public int lineToBottomY(int line)
}
/**
- * Converts a y co-ordinate to a line index.
- * @param y The y co-ordinate
+ * Converts a y coordinate to a line index.
+ * @param y The y coordinate
+ * @return The line index
*/
public int yToLine(int y)
{
@@ -489,6 +492,7 @@ public int yToLine(int y)
* slow version that can be used any time.
* @param line The line
* @param offset The offset, from the start of the line
+ * @return The X coordinate
*/
public final int offsetToX(int line, int offset)
{
@@ -503,6 +507,7 @@ public final int offsetToX(int line, int offset)
* to the text since the last repaint.
* @param line The line
* @param offset The offset, from the start of the line
+ * @return The X coordinate
*/
public int _offsetToX(int line, int offset)
{
@@ -580,6 +585,7 @@ public int _offsetToX(int line, int offset)
* Converts an x co-ordinate to an offset within a line.
* @param line The line
* @param x The x co-ordinate
+ * @return the offset within the line
*/
public int xToOffset(int line, int x)
{
@@ -690,6 +696,7 @@ public int xToOffset(int line, int x)
* Converts a point to an offset, from the start of the text.
* @param x The x co-ordinate of the point
* @param y The y co-ordinate of the point
+ * @return The offset from the start of the text
*/
public int xyToOffset(int x, int y)
{
@@ -699,7 +706,7 @@ public int xyToOffset(int x, int y)
}
/**
- * Returns the document this text area is editing.
+ * @return the document this text area is editing.
*/
public final SyntaxDocument getDocument()
{
@@ -726,7 +733,7 @@ public void setDocument(SyntaxDocument document)
}
/**
- * Returns the document's token marker. Equivalent to calling
+ * @return the document's token marker. Equivalent to calling
* getDocument().getTokenMarker().
*/
public final TokenMarker getTokenMarker()
@@ -745,7 +752,7 @@ public final void setTokenMarker(TokenMarker tokenMarker)
}
/**
- * Returns the length of the document. Equivalent to calling
+ * @return the length of the document. Equivalent to calling
* getDocument().getLength().
*/
public final int getDocumentLength()
@@ -754,7 +761,7 @@ public final int getDocumentLength()
}
/**
- * Returns the number of lines in the document.
+ * @return the number of lines in the document.
*/
public final int getLineCount()
{
@@ -762,7 +769,7 @@ public final int getLineCount()
}
/**
- * Returns the line containing the specified offset.
+ * @return the line containing the specified offset.
* @param offset The offset
*/
public final int getLineOfOffset(int offset)
@@ -771,7 +778,6 @@ public final int getLineOfOffset(int offset)
}
/**
- * Returns the start offset of the specified line.
* @param line The line
* @return The start offset of the specified line, or -1 if the line is
* invalid
@@ -787,7 +793,6 @@ public int getLineStartOffset(int line)
}
/**
- * Returns the end offset of the specified line.
* @param line The line
* @return The end offset of the specified line, or -1 if the line is
* invalid.
@@ -803,7 +808,7 @@ public int getLineEndOffset(int line)
}
/**
- * Returns the length of the specified line.
+ * @return the length of the specified line.
* @param line The line
*/
public int getLineLength(int line)
@@ -818,7 +823,7 @@ public int getLineLength(int line)
}
/**
- * Returns the entire text of this text area.
+ * @return the entire text of this text area.
*/
public String getText()
{
@@ -835,6 +840,7 @@ public String getText()
/**
* Sets the entire text of this text area.
+ * @param text The entire text
*/
public void setText(String text)
{
@@ -908,6 +914,7 @@ public final String getLineText(int lineIndex)
* Copies the text on the specified line into a segment. If the line
* is invalid, the segment will contain a null string.
* @param lineIndex The line
+ * @param segment into which the line is copied
*/
public final void getLineText(int lineIndex, Segment segment)
{
@@ -916,7 +923,7 @@ public final void getLineText(int lineIndex, Segment segment)
}
/**
- * Returns the selection start offset.
+ * @return the selection start offset.
*/
public final int getSelectionStart()
{
@@ -924,8 +931,8 @@ public final int getSelectionStart()
}
/**
- * Returns the offset where the selection starts on the specified
- * line.
+ * @return the offset where the selection starts on the specified line.
+ * @param line containing a selection
*/
public int getSelectionStart(int line)
{
@@ -947,7 +954,7 @@ else if(rectSelect)
}
/**
- * Returns the selection start line.
+ * @return the selection start line.
*/
public final int getSelectionStartLine()
{
@@ -966,7 +973,7 @@ public final void setSelectionStart(int selectionStart)
}
/**
- * Returns the selection end offset.
+ * @return the selection end offset.
*/
public final int getSelectionEnd()
{
@@ -974,8 +981,8 @@ public final int getSelectionEnd()
}
/**
- * Returns the offset where the selection ends on the specified
- * line.
+ * @return the offset where the selection ends on the specified line.
+ * @param line into which the offset is measured
*/
public int getSelectionEnd(int line)
{
@@ -997,7 +1004,7 @@ else if(rectSelect)
}
/**
- * Returns the selection end line.
+ * @return the selection end line.
*/
public final int getSelectionEndLine()
{
@@ -1016,7 +1023,7 @@ public final void setSelectionEnd(int selectionEnd)
}
/**
- * Returns the caret position. This will either be the selection
+ * @return the caret position. This will either be the selection
* start or the selection end, depending on which direction the
* selection was made in.
*/
@@ -1026,7 +1033,7 @@ public final int getCaretPosition()
}
/**
- * Returns the caret line.
+ * @return the caret line.
*/
public final int getCaretLine()
{
@@ -1034,7 +1041,7 @@ public final int getCaretLine()
}
/**
- * Returns the mark position. This will be the opposite selection
+ * @return the mark position. This will be the opposite selection
* bound to the caret position.
* @see #getCaretPosition()
*/
@@ -1044,7 +1051,7 @@ public final int getMarkPosition()
}
/**
- * Returns the mark line.
+ * @return the mark line.
*/
public final int getMarkLine()
{
@@ -1159,7 +1166,7 @@ public void select(int start, int end)
}
/**
- * Returns the selected text, or null if no selection is active.
+ * @return the selected text, or null if no selection is active.
*/
public final String getSelectedText()
{
@@ -1312,7 +1319,7 @@ public void setSelectedText(String selectedText)
}
/**
- * Returns true if this text area is editable, false otherwise.
+ * @return true if this text area is editable, false otherwise.
*/
public final boolean isEditable()
{
@@ -1330,7 +1337,7 @@ public final void setEditable(boolean editable)
}
/**
- * Returns the right click popup menu.
+ * @return the right click popup menu.
*/
public final JPopupMenu getRightClickPopup()
{
@@ -1347,7 +1354,7 @@ public final void setRightClickPopup(JPopupMenu popup)
}
/**
- * Returns the `magic' caret position. This can be used to preserve
+ * @return the `magic' caret position. This can be used to preserve
* the column position when moving up and down lines.
*/
public final int getMagicCaretPosition()
@@ -1409,7 +1416,7 @@ public void overwriteSetSelectedText(String str)
}
/**
- * Returns true if overwrite mode is enabled, false otherwise.
+ * @return true if overwrite mode is enabled, false otherwise.
*/
public final boolean isOverwriteEnabled()
{
@@ -1428,7 +1435,7 @@ public final void setOverwriteEnabled(boolean overwrite)
}
/**
- * Returns true if the selection is rectangular, false otherwise.
+ * @return true if the selection is rectangular, false otherwise.
*/
public final boolean isSelectionRectangular()
{
@@ -1447,7 +1454,7 @@ public final void setSelectionRectangular(boolean rectSelect)
}
/**
- * Returns the position of the highlighted bracket (the bracket
+ * @return the position of the highlighted bracket (the bracket
* matching the one before the caret)
*/
public final int getBracketPosition()
@@ -1456,7 +1463,7 @@ public final int getBracketPosition()
}
/**
- * Returns the line of the highlighted bracket (the bracket
+ * @return the line of the highlighted bracket (the bracket
* matching the one before the caret)
*/
public final int getBracketLine()
diff --git a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/KeywordMap.java b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/KeywordMap.java
index 57e026d6..b75ce4b1 100644
--- a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/KeywordMap.java
+++ b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/KeywordMap.java
@@ -50,6 +50,7 @@ public KeywordMap(boolean ignoreCase, int mapLength)
* @param text The text segment
* @param offset The offset of the substring within the text segment
* @param length The length of the substring
+ * @return the key
*/
public byte lookup(Segment text, int offset, int length)
{
@@ -83,7 +84,7 @@ public void add(String keyword, byte id)
}
/**
- * Returns true if the keyword map is set to be case insensitive,
+ * @return true if the keyword map is set to be case insensitive,
* false otherwise.
*/
public boolean getIgnoreCase()
diff --git a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxDocument.java b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxDocument.java
index 2e725a1f..9a145036 100644
--- a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxDocument.java
+++ b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxDocument.java
@@ -26,7 +26,7 @@
public class SyntaxDocument extends PlainDocument
{
/**
- * Returns the token marker that is to be used to split lines
+ * @return the token marker that is to be used to split lines
* of this document up into tokens. May return null if this
* document is not to be colorized.
*/
diff --git a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxStyle.java b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxStyle.java
index ad91ab95..9dc8a9a4 100644
--- a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxStyle.java
+++ b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxStyle.java
@@ -36,7 +36,7 @@ public SyntaxStyle(Color color, boolean italic, boolean bold)
}
/**
- * Returns the color specified in this style.
+ * @return the color specified in this style.
*/
public Color getColor()
{
@@ -44,7 +44,7 @@ public Color getColor()
}
/**
- * Returns true if no font styles are enabled.
+ * @return true if no font styles are enabled.
*/
public boolean isPlain()
{
@@ -52,7 +52,7 @@ public boolean isPlain()
}
/**
- * Returns true if italics is enabled for this style.
+ * @return true if italics is enabled for this style.
*/
public boolean isItalic()
{
@@ -60,7 +60,7 @@ public boolean isItalic()
}
/**
- * Returns true if boldface is enabled for this style.
+ * @return true if boldface is enabled for this style.
*/
public boolean isBold()
{
@@ -68,8 +68,9 @@ public boolean isBold()
}
/**
- * Returns the specified font, but with the style's bold and
+ * @return the specified font, but with the style's bold and
* italic flags applied.
+ * @param font The unperturbed font
*/
public Font getStyledFont(Font font)
{
@@ -87,7 +88,8 @@ public Font getStyledFont(Font font)
}
/**
- * Returns the font metrics for the styled font.
+ * @return the font metrics for the styled font.
+ * @param font The font for which the metrics are obtained.
*/
@SuppressWarnings("deprecation")
public FontMetrics getFontMetrics(Font font)
@@ -121,7 +123,7 @@ public void setGraphicsFlags(Graphics gfx, Font font)
}
/**
- * Returns a string representation of this object.
+ * @return a string representation of this object.
*/
public String toString()
{
diff --git a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxUtilities.java b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxUtilities.java
index 23bd9936..e9ca2c48 100644
--- a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxUtilities.java
+++ b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/SyntaxUtilities.java
@@ -32,6 +32,7 @@ public class SyntaxUtilities
* @param text The segment
* @param offset The offset into the segment
* @param match The string to match
+ * @return true if they match
*/
public static boolean regionMatches(boolean ignoreCase, Segment text,
int offset, String match)
@@ -62,6 +63,7 @@ public static boolean regionMatches(boolean ignoreCase, Segment text,
* @param text The segment
* @param offset The offset into the segment
* @param match The character array to match
+ * @return true if they match
*/
public static boolean regionMatches(boolean ignoreCase, Segment text,
int offset, char[] match)
@@ -86,7 +88,7 @@ public static boolean regionMatches(boolean ignoreCase, Segment text,
}
/**
- * Returns the default style table. This can be passed to the
+ * @return the default style table. This can be passed to the
* setStyles() method of SyntaxDocument
* to use the default syntax styles.
*/
diff --git a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextAreaDefaults.java b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextAreaDefaults.java
index c793e6ff..160415df 100644
--- a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextAreaDefaults.java
+++ b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextAreaDefaults.java
@@ -47,7 +47,7 @@ public class TextAreaDefaults
public JPopupMenu popup;
/**
- * Returns a new TextAreaDefaults object with the default values filled
+ * @return a new TextAreaDefaults object with the default values filled
* in.
*/
public static TextAreaDefaults getDefaults()
diff --git a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextAreaPainter.java b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextAreaPainter.java
index d20d5ad9..9665da15 100644
--- a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextAreaPainter.java
+++ b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextAreaPainter.java
@@ -38,6 +38,8 @@ public class TextAreaPainter extends JComponent implements TabExpander
/**
* Creates a new repaint manager. This should be not be called
* directly.
+ * @param textArea The area of interest
+ * @param defaults TODO
*/
/*static BufferedImage backgroundImage;
static {
@@ -82,7 +84,7 @@ public TextAreaPainter(JEditTextArea textArea, TextAreaDefaults defaults)
}
/**
- * Returns if this component can be traversed by pressing the
+ * @return if this component can be traversed by pressing the
* Tab key. This returns false.
*/
public final boolean isManagingFocus()
@@ -91,7 +93,7 @@ public final boolean isManagingFocus()
}
/**
- * Returns the syntax styles used to paint colorized text. Entry n
+ * @return the syntax styles used to paint colorized text. Entry n
* will be used to paint tokens with id = n.
* @see Token
*/
@@ -113,7 +115,7 @@ public final void setStyles(SyntaxStyle[] styles)
}
/**
- * Returns the caret color.
+ * @return the caret color.
*/
public final Color getCaretColor()
{
@@ -131,7 +133,7 @@ public final void setCaretColor(Color caretColor)
}
/**
- * Returns the selection color.
+ * @return the selection color.
*/
public final Color getSelectionColor()
{
@@ -149,7 +151,7 @@ public final void setSelectionColor(Color selectionColor)
}
/**
- * Returns the line highlight color.
+ * @return the line highlight color.
*/
public final Color getLineHighlightColor()
{
@@ -167,7 +169,7 @@ public final void setLineHighlightColor(Color lineHighlightColor)
}
/**
- * Returns true if line highlight is enabled, false otherwise.
+ * @return true if line highlight is enabled, false otherwise.
*/
public final boolean isLineHighlightEnabled()
{
@@ -186,7 +188,7 @@ public final void setLineHighlightEnabled(boolean lineHighlight)
}
/**
- * Returns the bracket highlight color.
+ * @return the bracket highlight color.
*/
public final Color getBracketHighlightColor()
{
@@ -204,7 +206,7 @@ public final void setBracketHighlightColor(Color bracketHighlightColor)
}
/**
- * Returns true if bracket highlighting is enabled, false otherwise.
+ * @return true if bracket highlighting is enabled, false otherwise.
* When bracket highlighting is enabled, the bracket matching the
* one before the caret (if any) is highlighted.
*/
@@ -227,7 +229,7 @@ public final void setBracketHighlightEnabled(boolean bracketHighlight)
}
/**
- * Returns true if the caret should be drawn as a block, false otherwise.
+ * @return true if the caret should be drawn as a block, false otherwise.
*/
public final boolean isBlockCaretEnabled()
{
@@ -246,7 +248,7 @@ public final void setBlockCaretEnabled(boolean blockCaret)
}
/**
- * Returns the EOL marker color.
+ * @return the EOL marker color.
*/
public final Color getEOLMarkerColor()
{
@@ -264,7 +266,7 @@ public final void setEOLMarkerColor(Color eolMarkerColor)
}
/**
- * Returns true if EOL markers are drawn, false otherwise.
+ * @return true if EOL markers are drawn, false otherwise.
*/
public final boolean getEOLMarkersPainted()
{
@@ -282,7 +284,7 @@ public final void setEOLMarkersPainted(boolean eolMarkers)
}
/**
- * Returns true if invalid lines are painted as red tildes (~),
+ * @return true if invalid lines are painted as red tildes (~),
* false otherwise.
*/
public boolean getInvalidLinesPainted()
@@ -331,7 +333,7 @@ public interface Highlight
void paintHighlight(Graphics gfx, int line, int y);
/**
- * Returns the tool tip to display at the specified
+ * @return the tool tip to display at the specified
* location. If this highlighter doesn't know what to
* display, it should delegate to the next highlight
* painter.
@@ -341,7 +343,7 @@ public interface Highlight
}
/**
- * Returns the tool tip to display at the specified location.
+ * @return the tool tip to display at the specified location.
* @param evt The mouse event
*/
public String getToolTipText(MouseEvent evt)
@@ -353,7 +355,7 @@ public String getToolTipText(MouseEvent evt)
}
/**
- * Returns the font metrics used by this component.
+ * @return the font metrics used by this component.
*/
public FontMetrics getFontMetrics()
{
@@ -470,7 +472,7 @@ public float nextTabStop(float x, int tabOffset)
}
/**
- * Returns the painter's preferred size.
+ * @return the painter's preferred size.
*/
public Dimension getPreferredSize()
{
@@ -482,7 +484,7 @@ public Dimension getPreferredSize()
/**
- * Returns the painter's minimum size.
+ * @return the painter's minimum size.
*/
public Dimension getMinimumSize()
{
diff --git a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextUtilities.java b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextUtilities.java
index b2f54858..36bdc6a6 100644
--- a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextUtilities.java
+++ b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TextUtilities.java
@@ -19,7 +19,7 @@
public class TextUtilities
{
/**
- * Returns the offset of the bracket matching the one at the
+ * @return the offset of the bracket matching the one at the
* specified offset of the document, or -1 if the bracket is
* unmatched (or if the character is not a bracket).
* @param doc The document
@@ -129,6 +129,8 @@ else if(x == cprime)
* Locates the start of the word at the specified position.
* @param line The text
* @param pos The position
+ * @param noWordSep The word separator
+ * @return the position of the start of the word
*/
public static int findWordStart(String line, int pos, String noWordSep)
{
@@ -158,6 +160,8 @@ public static int findWordStart(String line, int pos, String noWordSep)
* Locates the end of the word at the specified position.
* @param line The text
* @param pos The position
+ * @param noWordSep The word separator
+ * @return the position of the end of the word
*/
public static int findWordEnd(String line, int pos, String noWordSep)
{
diff --git a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TokenMarker.java b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TokenMarker.java
index 82202e1d..07403ed2 100644
--- a/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TokenMarker.java
+++ b/ochafik-swing/src/main/java/com/ochafik/swing/syntaxcoloring/TokenMarker.java
@@ -31,6 +31,7 @@ public abstract class TokenMarker
* that is called to split a line up into tokens.
* @param line The line
* @param lineIndex The line number
+ * @return the token at the indicated position
*/
public Token markTokens(Segment line, int lineIndex)
{
@@ -124,7 +125,7 @@ protected abstract byte markTokensImpl(byte token, Segment line,
int lineIndex);
/**
- * Returns if the token marker supports tokens that span multiple
+ * @return if the token marker supports tokens that span multiple
* lines. If this is true, the object using this token marker is
* required to pass all lines in the document to the
* markTokens() method (in turn).
@@ -178,7 +179,7 @@ public void deleteLines(int index, int lines)
}
/**
- * Returns the number of lines in this token marker.
+ * @return the number of lines in this token marker.
*/
public int getLineCount()
{
@@ -186,7 +187,7 @@ public int getLineCount()
}
/**
- * Returns true if the next line should be repainted. This
+ * @return true if the next line should be repainted. This
* will return true after a line has been tokenized that starts
* a multiline token that continues onto the next line.
*/
@@ -319,6 +320,8 @@ public LineInfo()
/**
* Creates a new LineInfo object with the specified
* parameters.
+ * @param token TODO
+ * @param obj TODO
*/
public LineInfo(byte token, Object obj)
{
diff --git a/ochafik-util/.classpath b/ochafik-util/.classpath
index 4cf68d6b..9bef8d6b 100644
--- a/ochafik-util/.classpath
+++ b/ochafik-util/.classpath
@@ -1,9 +1,46 @@