Browse Source

Javadoc fixes

Change-Id: I768dd2ab9c9934dbe6acc16b6c8b98b9561a6250
Reviewed-on: http://gerrit.dmdirc.com/597
Reviewed-by: Shane Mc Cormack <shane@dmdirc.com>
Automatic-Compile: Shane Mc Cormack <shane@dmdirc.com>
tags/0.6.3b1
Chris Smith 14 years ago
parent
commit
629c83a678

+ 4
- 1
src/com/dmdirc/ui/input/InputHandler.java View File

@@ -399,7 +399,8 @@ public abstract class InputHandler implements ConfigChangeListener {
399 399
      * Handles tab completion of a string. Called when the user presses
400 400
      * (shift) tab.
401 401
      *
402
-     * @param shiftPressed True if shift is pressed
402
+     * @param shiftPressed True iff shift is pressed
403
+     * @since 0.6.3
403 404
      */
404 405
     protected void doTabCompletion(final boolean shiftPressed) {
405 406
         if (tabCompleter == null || (flags & HANDLE_TABCOMPLETION) == 0) {
@@ -453,6 +454,7 @@ public abstract class InputHandler implements ConfigChangeListener {
453 454
      * @param text The text that is being completed
454 455
      * @param start The start index of the word we're completing
455 456
      * @param end The end index of the word we're completing
457
+     * @param shiftPressed True iff shift is pressed
456 458
      */
457 459
     private void doCommandTabCompletion(final String text, final int start,
458 460
             final int end, final boolean shiftPressed) {
@@ -467,6 +469,7 @@ public abstract class InputHandler implements ConfigChangeListener {
467 469
      * @param start The start index of the word we're completing
468 470
      * @param end The end index of the word we're completing
469 471
      * @param additional A list of additional strings to use
472
+     * @param shiftPressed True iff shift is pressed
470 473
      */
471 474
     private void doNormalTabCompletion(final String text, final int start,
472 475
             final int end, final boolean shiftPressed,

+ 3
- 0
src/com/dmdirc/ui/input/tabstyles/TabCompletionStyle.java View File

@@ -38,8 +38,11 @@ public interface TabCompletionStyle {
38 38
      * @param original The original string which the user inputted
39 39
      * @param start The start offset of the word that's being tab-completed
40 40
      * @param end The end offset of the word that's being tab-completed
41
+     * @param shiftPressed True iff shift is pressed
41 42
      * @param additional A list of additional targets which may match
43
+     *
42 44
      * @return This style's proposed result
45
+     * @since 0.6.3
43 46
      */
44 47
     TabCompletionResult getResult(final String original, final int start,
45 48
             final int end, final boolean shiftPressed,

Loading…
Cancel
Save