Skip to content

Commit 19fad54

Browse files
committed
#21 aligned documentation
1 parent 59bc52a commit 19fad54

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ In order to be able to use the `@WTF` annotation, the following dependency must
7070
<dependency>
7171
<groupId>com.qualinsight.plugins.sonarqube</groupId>
7272
<artifactId>qualinsight-plugins-sonarqube-wtf-api</artifactId>
73-
<version>1.0.2</version>
73+
<version>1.0.3</version>
7474
</dependency>
7575
```
7676

@@ -116,16 +116,18 @@ The WTFType enum currently can take the following values (greatly inspired by Co
116116

117117
| WTFType | When should I use it ? |
118118
|----------------------------|----------------------------------------------------------------------------|
119-
| ANTI_PATTERN | An anti-pattern has been used.  |
120119
| ABBREVIATIONS_USAGE | Confusing abbreviations are being used instead of explicit names |
120+
| ANTI_PATTERN | An anti-pattern has been used.  |
121121
| BAD_DESIGN | The design is really bad and should be improved. |
122+
| BAD_FRAMEWORK_USAGE | A framework is not used the way it should |
122123
| BAD_LOGGING | The logging message, level, is inappropriate or the log is redundant. |
123-
| NON_EXCEPTION | The exceptions mechanism is used for non exceptional cases. |
124124
| HOW_COMMENT | The comment or documentation focuses on the "how" instead of the "what" |
125125
| INDECENT_EXPOSURE | The class unnecessarily exposes its internals. |
126126
| MEANINGLESS_COMMENT | The comment or documentation text is meaningless. |
127127
| MIDDLE_MAN | The class delegates all its work, is it really needed ? |
128128
| MISSING_IMPLEMENTATION | A method's implementation is missing. |
129+
| MULTIPLE_RESPONSIBILITIES | The class or method has multiple responsibilities. |
130+
| NON_EXCEPTION | The exceptions mechanism is used for non exceptional cases. |
129131
| ODDBALL_SOLUTION | The problem is solved in multiple ways throughout the system. |
130132
| OVERCOMPLICATED_ALGORITHM | There is a way to simplify an algorithm. |
131133
| PRIMITIVES_OBSESSION | The code relies too much on primitives instead of classes. |
@@ -134,7 +136,6 @@ The WTFType enum currently can take the following values (greatly inspired by Co
134136
| SOLUTION_SPRAWL | It takes too many classes to do anything useful. |
135137
| SPECULATIVE_GENERALITY | The code is written thinking about tomorrow's problems. |
136138
| UNCOMMUNICATIVE_NAME | The name does not communicate the purpose of the class, field, method. |
137-
| UNCORRECT_FRAMEWORK_USAGE | A framework is not used the way it should |
138139
| USELESS_TEST | The test is useless (it tests nothing) |
139140
| WRONG_LANGUAGE | Wrong language (french, english, german...) is being used |
140141
| WRONG_LOGIC | Wrong (business) logic is being used. |

0 commit comments

Comments
 (0)