Skip to content
This repository has been archived by the owner on Jan 27, 2025. It is now read-only.

Commit

Permalink
Validate Javadoc as part of the checks.
Browse files Browse the repository at this point in the history
  • Loading branch information
blackwinter committed Nov 12, 2021
1 parent 7ca1a4b commit ecc0c15
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
14 changes: 13 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ editorconfig {
check.dependsOn(editorconfigCheck)

subprojects {

ext {
versions = [
'ace': '1.3.3',
Expand Down Expand Up @@ -48,6 +47,8 @@ subprojects {

apply from: "${rootDir}/gradle/source-layout.gradle"

check.dependsOn(javadoc)

sourceCompatibility = '1.8'
targetCompatibility = '1.8'

Expand Down Expand Up @@ -76,6 +77,17 @@ subprojects {
options.compilerArgs << '-Werror'
}

javadoc {
// Can't exclude generated files based on source path
// (cf. https://stackoverflow.com/a/47711311).
//exclude '**/xtext-gen'
source = source.filter(f -> !f.getPath().contains('xtext-gen'))

options {
addBooleanOption 'Xwerror', true
}
}

publishing {
publications {
mavenArtifacts(MavenPublication) {
Expand Down
6 changes: 4 additions & 2 deletions config/checkstyle/checkstyle.xml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
<module name="InterfaceIsType"/>
<module name="InterfaceTypeParameterName"/>
<module name="JavaNCSS"/>
<module name="JavadocMethod"/>
<module name="JavadocType"/>
<module name="LambdaParameterName"/>
<module name="LeftCurly"/>
Expand All @@ -92,14 +93,15 @@
</module>
<module name="MultipleVariableDeclarations"/>
<module name="MutableException"/>
<module name="NeedBraces"/>
<module name="NPathComplexity"/>
<module name="NeedBraces"/>
<module name="NoArrayTrailingComma"/>
<module name="NoClone"/>
<module name="NoEnumTrailingComma"/>
<module name="NoFinalizer"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="NonEmptyAtclauseDescription"/>
<module name="OneStatementPerLine">
<property name="treatTryResourcesAsStatement" value="true"/>
</module>
Expand Down Expand Up @@ -151,8 +153,8 @@
<module name="ThrowsCount">
<property name="max" value="2"/>
</module>
<module name="TypecastParenPad"/>
<module name="TypeName"/>
<module name="TypecastParenPad"/>
<module name="UnnecessaryParentheses"/>
<module name="UnnecessarySemicolonAfterTypeMemberDeclaration"/>
<module name="UnnecessarySemicolonInEnumeration"/>
Expand Down

0 comments on commit ecc0c15

Please sign in to comment.