Skip to content

Commit 6e279d0

Browse files
committedJan 21, 2025·
Add property commons.javadoc.failOnWarnings set to true
A component must now explicitly allow poorly written or incomplete Javadoc
1 parent 9d454ef commit 6e279d0

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed
 

‎pom.xml

+2
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,7 @@
225225
<project.build.sourceEncoding>${commons.encoding}</project.build.sourceEncoding>
226226
<!-- This is used by reporting plugins -->
227227
<project.reporting.outputEncoding>${commons.encoding}</project.reporting.outputEncoding>
228+
<commons.javadoc.failOnWarnings>true</commons.javadoc.failOnWarnings>
228229
<!-- Javadoc link to Java API LTS versions. -->
229230
<!-- Modern Javadoc versions redirect to newest site (Java 22) when you ask for older links like Java 8. -->
230231
<commons.javadoc.java.link>https://docs.oracle.com/en/java/javase/21/docs/api/</commons.javadoc.java.link>
@@ -467,6 +468,7 @@
467468
&lt;a href="${project.issueManagement.url}">Issue management&lt;/a&gt; |
468469
&lt;a href="${project.scm.url}">Source repository&lt;/a&gt;
469470
</bottom>
471+
<failOnWarnings>${commons.javadoc.failOnWarnings}</failOnWarnings>
470472
</configuration>
471473
</plugin>
472474
<plugin>

‎src/changes/changes.xml

+1
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ The <action> type attribute can be add,update,fix,remove.
6464
<!-- ADD -->
6565
<action type="add" dev="ggregory" due-to="Gary Gregory">Add property commons.main.branch.</action>
6666
<action type="add" dev="ggregory" due-to="Gary Gregory">Add property commons.release.branch.</action>
67+
<action type="add" dev="ggregory" due-to="Gary Gregory">Add property commons.javadoc.failOnWarnings set to true.</action>
6768
<!-- UPDATE -->
6869
<action type="update" dev="engelen" due-to="Dependabot, Arnout Engelen">Bump com.github.siom79.japicmp:japicmp-maven-plugin from 0.23.0 to 0.23.1 #574.</action>
6970
<action type="update" dev="ggregory" due-to="Dependabot, Gary Gregory">Bump org.apache.commons:commons-release-plugin from 1.8.3 to 1.9.0 #576.</action>

0 commit comments

Comments
 (0)
Please sign in to comment.