Skip to content

Commit

Permalink
Add the GAV coordinates of the annotations to the documentation (spot…
Browse files Browse the repository at this point in the history
…bugs#3137)

* Doc: added the GAV coordinates of the annotations to the documentation

* try with a newline before the code block directive

* Try using parsed-literal to get the release version substitution

* Reuse the generated includes for the Maven and Gradle deps declarations
  • Loading branch information
gtoison authored Oct 6, 2024
1 parent 2d48463 commit b42b24a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/annotations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Annotations
SpotBugs supports several annotations to express the developer's intent so that SpotBugs can issue warnings more appropriately.
Annotations for SpotBugs.

.. literalinclude:: generated/migration-findbugs-annotations-maven.template.inc
:language: xml

.. literalinclude:: generated/migration-findbugs-annotations-gradle.template.inc
:language: groovy

edu.umd.cs.findbugs.annotations.CheckForNull
--------------------------------------------
The annotated element might be null, and uses of the element should check for null.
Expand Down

0 comments on commit b42b24a

Please sign in to comment.