Skip to content

Commit 20b47a7

Browse files
committed
style: modify TODO comments to workaround buggy pdd behavior and make titles look good
See for details: cqfn/pdd#111 Relate to #1610
1 parent a4c6ea4 commit 20b47a7

File tree

2 files changed

+27
-9
lines changed

2 files changed

+27
-9
lines changed

Diff for: pom.xml

+9-3
Original file line numberDiff line numberDiff line change
@@ -892,9 +892,13 @@
892892
<compilerArgs>
893893
<compilerArg>-Xlint:unchecked</compilerArg>
894894
<!-- Required for ErrorProne -->
895-
<!-- @todo #971 Document ErrorProne tool -->
895+
<!--
896+
@todo #971 Document ErrorProne tool
897+
-->
896898
<compilerArg>-XDcompilePolicy=simple</compilerArg>
897-
<!-- @todo #1170 ErrorProne: activate experimental checks -->
899+
<!--
900+
@todo #1170 ErrorProne: activate experimental checks
901+
-->
898902
<!--
899903
The following checks have been disabled:
900904
- MissingOverride: produce false positives with @Getter from Lombok
@@ -1320,7 +1324,9 @@
13201324
</activation>
13211325
<build>
13221326
<plugins>
1323-
<!-- @todo #1060 Document usage of frontend-maven-plugin -->
1327+
<!--
1328+
@todo #1060 Document usage of frontend-maven-plugin
1329+
-->
13241330
<!--
13251331
We assume that most of the time we develop backend rather frontend.
13261332
So, we cache and skip the frontend-related things by default. This

Diff for: src/main/config/spotbugs-filter.xml

+18-6
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
55
xsi:schemaLocation="https://github.com/spotbugs/filter/3.0.0 https://raw.githubusercontent.com/spotbugs/spotbugs/3.1.0/spotbugs/etc/findbugsfilter.xsd">
66

7-
<!-- @todo #869 Find a better way to deal with SpotBugs warnings in DAO classes -->
7+
<!--
8+
@todo #869 Find a better way to deal with SpotBugs warnings in DAO classes
9+
-->
810
<Match>
911
<ClassType name="~Dao$" />
1012
<Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE" />
@@ -230,7 +232,9 @@
230232
<Bug pattern="NP_BOOLEAN_RETURN_NULL" />
231233
</Match>
232234
<Match>
233-
<!-- @todo #493 AddCategoryDbDto: port to a new datetime API -->
235+
<!--
236+
@todo #493 AddCategoryDbDto: port to a new datetime API
237+
-->
234238
<Class name="ru.mystamps.web.feature.category.AddCategoryDbDto" />
235239
<Or>
236240
<Method name="getCreatedAt" />
@@ -241,7 +245,9 @@
241245
<Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2" />
242246
</Match>
243247
<Match>
244-
<!-- @todo #493 AddCountryDbDto: port to a new datetime API -->
248+
<!--
249+
@todo #493 AddCountryDbDto: port to a new datetime API
250+
-->
245251
<Class name="ru.mystamps.web.feature.country.AddCountryDbDto" />
246252
<Or>
247253
<Method name="getCreatedAt" />
@@ -252,7 +258,9 @@
252258
<Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2" />
253259
</Match>
254260
<Match>
255-
<!-- @todo #493 AddCollectionDbDto: port to a new datetime API -->
261+
<!--
262+
@todo #493 AddCollectionDbDto: port to a new datetime API
263+
-->
256264
<Class name="ru.mystamps.web.feature.collection.AddCollectionDbDto" />
257265
<Or>
258266
<Method name="getUpdatedAt" />
@@ -261,12 +269,16 @@
261269
<Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2" />
262270
</Match>
263271
<Match>
264-
<!-- @todo #493 AddSuspiciousActivityDbDto: port to a new datetime API -->
272+
<!--
273+
@todo #493 AddSuspiciousActivityDbDto: port to a new datetime API
274+
-->
265275
<Class name="ru.mystamps.web.feature.site.AddSuspiciousActivityDbDto" />
266276
<Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2" />
267277
</Match>
268278
<Match>
269-
<!-- @todo #493 SuspiciousActivityDto: port to a new datetime API -->
279+
<!--
280+
@todo #493 SuspiciousActivityDto: port to a new datetime API
281+
-->
270282
<Class name="ru.mystamps.web.feature.site.SuspiciousActivityDto" />
271283
<Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2" />
272284
</Match>

0 commit comments

Comments
 (0)