Я использую Java 7 (хотя компилирую с использованием 1.6) для компиляции классов и javadocs. Я удалил все предупреждения javadoc, которые возникают, но идея состоит в том, чтобы сбой сборки был, если есть какие-либо предупреждения javadoc.Как скомпрометировать построение града на предупреждениях Javadoc
Использование Java 8, это поведение по умолчанию. НО, это также намного более строго, когда дело доходит до предупреждений (мы не хотим предупреждений, если метод не перечисляет все @params или @returns). Кроме того, я не вижу, чтобы компания перешла на 8 в ближайшее время, так что это спорный вопрос.
Я надеялся, что есть некоторый простой флаг, чтобы установить, что градиент не работает, если есть предупреждения (есть только failonError). То, о чем я думал, заключалось в том, чтобы очистить консольный выход процесса javadoc. Если этот вывод содержит ПРЕДУПРЕЖДЕНИЯ, то я знаю, что есть предупреждения, и сборка должна завершиться неудачей.
Вот мой Javadoc блок в моем build.gradle:
task gendocs(type: Javadoc) {
options.stylesheetFile = new File("./assets/doc_style.css")
options.windowTitle = "OurTitle"
options.memberLevel = JavadocMemberLevel.PROTECTED
options.author = true
options.linksOffline('http://d.android.com/reference', System.getenv("ANDROID_HOME") + '/docs/reference')
String v = "${SEMVER}"
version = v.replace("_", '.')
destinationDir = new File("${BUNDLE_FOLDER}/docs/api")
source = sourceSets.main.allJava
classpath += configurations.compile
}
Итак, если есть не более простой способ сделать это, как я могу проверить выход консольной Javadoc, чтобы очистить его?
Возможно, проблема заключается в том, что вы настраиваете задачу gendocs, а задача, которая их генерирует по умолчанию при использовании плагина java, называется 'javadoc'? – madhead
Не имеет значения. Я решил просто реализовать checkstyle. –
Не стесняйтесь повышать реальное исправление для этого https://discuss.gradle.org/t/javadoc-fail-on-warning/18141 – tir38