Kaynağa Gözat

Fix stupid javadoc formatting.

Change-Id: I8cf58d5fc06911eaf1fa35ee9b81abb5206dd70e
Reviewed-on: http://gerrit.dmdirc.com/1343
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>
tags/0.6.4
Shane Mc Cormack 14 yıl önce
ebeveyn
işleme
1032efdb04

+ 1
- 2
src/com/dmdirc/parser/common/CallbackNotFoundException.java Dosyayı Görüntüle

@@ -38,8 +38,7 @@ public class CallbackNotFoundException extends RuntimeException {
38 38
     /**
39 39
      * Create a new CallbackNotFound Exception.
40 40
      * 
41
-     * @param message
42
-     *            Reason for exception
41
+     * @param message Reason for exception
43 42
      */
44 43
     public CallbackNotFoundException(final String message) {
45 44
         super(message);

+ 4
- 8
src/com/dmdirc/parser/common/ChannelListModeItem.java Dosyayı Görüntüle

@@ -43,15 +43,11 @@ public final class ChannelListModeItem {
43 43
     /**
44 44
      * Create a new Item.
45 45
      * 
46
-     * @param item
47
-     *            The item (ie: test!joe@user.com)
48
-     * @param owner
49
-     *            The owner (ie: Dataforce)
50
-     * @param time
51
-     *            The Time (ie: 1173389295)
46
+     * @param item The item (ie: test!joe@user.com)
47
+     * @param owner The owner (ie: Dataforce)
48
+     * @param time The Time (ie: 1173389295)
52 49
      */
53
-    public ChannelListModeItem(final String item, final String owner,
54
-            final long time) {
50
+    public ChannelListModeItem(final String item, final String owner, final long time) {
55 51
         myItem = item;
56 52
         myTime = time;
57 53
 

+ 9
- 10
src/com/dmdirc/parser/common/MyInfo.java Dosyayı Görüntüle

@@ -33,8 +33,10 @@ public class MyInfo {
33 33
 
34 34
     /** Character to prepend to nickname if in use (Default "_"). */
35 35
     private char prependChar = '_';
36
+
36 37
     /** Nickname to attempt to use on IRC. */
37 38
     private String nickname;
39
+
38 40
     /**
39 41
      * Alternative nickname to attempt to use on IRC. If the first nickname is
40 42
      * in use, and a NickInUse message is recieved before 001, we will attempt
@@ -43,8 +45,10 @@ public class MyInfo {
43 45
      * (_) to the main nickname
44 46
      */
45 47
     private String altNickname;
48
+
46 49
     /** Realname string to use */
47 50
     private String realname;
51
+
48 52
     /** Username to use, this doesn't matter when an ident server is running */
49 53
     private String username;
50 54
 
@@ -74,8 +78,7 @@ public class MyInfo {
74 78
     /**
75 79
      * Set the Nickname.
76 80
      *
77
-     * @param newValue
78
-     *            Value to set to.
81
+     * @param newValue Value to set to.
79 82
      */
80 83
     public void setNickname(final String newValue) {
81 84
         if (newValue != null && !newValue.isEmpty()) {
@@ -95,8 +98,7 @@ public class MyInfo {
95 98
     /**
96 99
      * Set the Alternative Nickname.
97 100
      *
98
-     * @param newValue
99
-     *            Value to set to.
101
+     * @param newValue Value to set to.
100 102
      */
101 103
     public void setAltNickname(final String newValue) {
102 104
         if (newValue != null && !newValue.isEmpty()) {
@@ -116,8 +118,7 @@ public class MyInfo {
116 118
     /**
117 119
      * Set the Realname.
118 120
      *
119
-     * @param newValue
120
-     *            Value to set to.
121
+     * @param newValue Value to set to.
121 122
      */
122 123
     public void setRealname(final String newValue) {
123 124
         if (newValue != null && !newValue.isEmpty()) {
@@ -137,8 +138,7 @@ public class MyInfo {
137 138
     /**
138 139
      * Set the Username.
139 140
      *
140
-     * @param newValue
141
-     *            Value to set to.
141
+     * @param newValue Value to set to.
142 142
      */
143 143
     public void setUsername(final String newValue) {
144 144
         if (newValue != null && !newValue.isEmpty()) {
@@ -158,8 +158,7 @@ public class MyInfo {
158 158
     /**
159 159
      * Set the Prepend Character.
160 160
      *
161
-     * @param newValue
162
-     *            Value to set to.
161
+     * @param newValue Value to set to.
163 162
      */
164 163
     public void setPrependChar(final char newValue) {
165 164
         prependChar = newValue;

+ 8
- 17
src/com/dmdirc/parser/common/ParserError.java Dosyayı Görüntüle

@@ -32,10 +32,7 @@ public final class ParserError {
32 32
     public static final int ERROR_FATAL = 1;
33 33
     /** Error is not fatal, but is more severe than a warning. */
34 34
     public static final int ERROR_ERROR = 2;
35
-    /**
36
-     * Error was an unexpected occurance, but shouldn't be anything to worry
37
-     * about.
38
-     */
35
+    /** Error was unexpected, but shouldn't be anything to worry about. */
39 36
     public static final int ERROR_WARNING = 4;
40 37
     /** Error is a user-error rather than a server error. */
41 38
     public static final int ERROR_USER = 8;
@@ -55,13 +52,10 @@ public final class ParserError {
55 52
     /**
56 53
      * Create a new Error.
57 54
      * 
58
-     * @param level
59
-     *            Set the error level.
60
-     * @param data
61
-     *            String containing information about the error.
62
-     * @param line
63
-     *            The last line of data recieved from the server before this
64
-     *            exception.
55
+     * @param level Set the error level.
56
+     * @param data String containing information about the error.
57
+     * @param line The last line of data recieved from the server before this
58
+     *             exception.
65 59
      */
66 60
     public ParserError(final int level, final String data, final String line) {
67 61
         errorData = data;
@@ -98,8 +92,7 @@ public final class ParserError {
98 92
     }
99 93
 
100 94
     /**
101
-     * Check if this error is considered a user-error rather than a server
102
-     * error.
95
+     * Check if this error is considered a user-error rather than a server error.
103 96
      * For DMDirc this will cause the error not to be reported to the developers
104 97
      * 
105 98
      * @return Returns true for a user error, else false.
@@ -129,8 +122,7 @@ public final class ParserError {
129 122
     /**
130 123
      * Set the Exception object.
131 124
      * 
132
-     * @param newException
133
-     *            The exception object to store
125
+     * @param newException The exception object to store
134 126
      */
135 127
     public void setException(final Exception newException) {
136 128
         exceptionInfo = newException;
@@ -169,8 +161,7 @@ public final class ParserError {
169 161
     /**
170 162
      * Add to the error information.
171 163
      * 
172
-     * @param data
173
-     *            Information to add to the end of the existing Data
164
+     * @param data Information to add to the end of the existing Data
174 165
      */
175 166
     public void appendData(final String data) {
176 167
         errorData += '[' + data + ']';

Loading…
İptal
Kaydet