Skip to content

Commit

Permalink
Issue checkstyle#4798: refactored SummaryJavadoc messages and logic
Browse files Browse the repository at this point in the history
  • Loading branch information
rnveach committed Aug 5, 2017
1 parent e360526 commit 26dfacd
Show file tree
Hide file tree
Showing 12 changed files with 17 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ public void testIncorrect() throws Exception {
"37: " + msgFirstSentence,
"47: " + msgForbiddenFragment,
"53: " + msgMissingDoc,
"58: " + msgForbiddenFragment,
"58: " + msgMissingDoc,
"69: " + msgMissingDoc,
"83: " + msgForbiddenFragment,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,19 +135,18 @@ public int[] getRequiredJavadocTokens() {
@Override
public void visitJavadocToken(DetailNode ast) {
if (!startsWithInheritDoc(ast)) {
String firstSentence = getFirstSentence(ast);
final int endOfSentence = firstSentence.lastIndexOf(period);
final String summaryDoc = getSummarySentence(ast);
if (summaryDoc.isEmpty()) {
log(ast.getLineNumber(), MSG_SUMMARY_JAVADOC_MISSING);
}
else if (!period.isEmpty()
&& !summaryDoc.contains(period)) {
log(ast.getLineNumber(), MSG_SUMMARY_FIRST_SENTENCE);
}
if (endOfSentence != -1) {
firstSentence = firstSentence.substring(0, endOfSentence);
if (containsForbiddenFragment(firstSentence)) {
else if (!period.isEmpty()) {
final String firstSentence = getFirstSentence(ast);
final int endOfSentence = firstSentence.lastIndexOf(period);
if (!summaryDoc.contains(period)) {
log(ast.getLineNumber(), MSG_SUMMARY_FIRST_SENTENCE);
}
if (endOfSentence != -1
&& containsForbiddenFragment(firstSentence.substring(0, endOfSentence))) {
log(ast.getLineNumber(), MSG_SUMMARY_JAVADOC);
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ javadoc.writeTag={0}={1}
javadoc.wrong.singleton.html.tag=Javadoc comment at column {0} has parse error. It is forbidden to close singleton HTML tags. Tag: {1}.
non.empty.atclause=At-clause should have a non-empty description.
singleline.javadoc=Single-line Javadoc comment should be multi-line.
summary.first.sentence=First sentence of Javadoc is incomplete (period is missing) or not present.
summary.first.sentence=First sentence of Javadoc is missing an ending period.
summary.javaDoc=Forbidden summary fragment.
summary.javaDoc.missing=Summary javadoc is missing.
tag.continuation.indent=Line continuation have incorrect indentation level, expected level should be {0}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ javadoc.writeTag={0}={1}
javadoc.wrong.singleton.html.tag=Der Javadoc-Kommentar an Position {0} führt zu einem Parserfehler. Singleton-HTML-Tags dürfen nicht geschlossen werden. Tag: {1}
non.empty.atclause=@-Klausel sollte eine nicht-leere Beschreibung haben.
singleline.javadoc=Einzeiliger Javadoc-Kommentar sollte auf mehrere Zeilen verteilt sein.
summary.first.sentence=Erster Javadoc-Satz ist unvollständig (Punkt fehlt) oder nicht vorhanden.
summary.first.sentence=Der erste Satz von Javadoc fehlt eine Endperiode.
summary.javaDoc=Verbotener Ausdruck im ersten Javadoc-Satz.
summary.javaDoc.missing=Zusammenfassung javadoc fehlt.
tag.continuation.indent=Fortsetzung der Zeile hat falsche Einrückungstiefe (erwartet: {0}).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ javadoc.writeTag={0}={1}
javadoc.wrong.singleton.html.tag=Javadoc comentario en la columna {0} tiene parse error. Está prohibido cerrar etiquetas HTML únicos. Tag: {1}
non.empty.atclause=Al cláusula debe tener una descripción que no esté vacía.
singleline.javadoc=Una sola línea Javadoc comentario debe ser de varias líneas.
summary.first.sentence=Primera frase del Javadoc es incompleta (período de falta) o no está presente.
summary.first.sentence=Primera frase de Javadoc falta un período final.
summary.javaDoc=Resumen fragmento Prohibida.
summary.javaDoc.missing=Resumen javadoc falta.
tag.continuation.indent=Línea continuación tiene nivel de sangría incorrecta, nivel esperado debería ser {0}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ javadoc.writeTag={0}={1}
javadoc.wrong.singleton.html.tag=Javadoc kommentti sarakkeessa {0} on Jäsennysvirhe. On kiellettyä sulkea yksittäiseksi HTML tageja. Tag: {1} .
non.empty.atclause=At-lauseke tulisi olla ei-tyhjä kuvaus.
singleline.javadoc=Yksilinjainen Javadoc kommentti pitäisi olla multi-line.
summary.first.sentence=Ensimmäinen virke Javadoc on epätäydellinen (ajanjakso puuttuu) tai ole läsnä.
summary.first.sentence=Javadocin ensimmäinen lause puuttuu päättymisajasta.
summary.javaDoc=Kielletty yhteenveto fragmentti.
summary.javaDoc.missing=Yhteenveto javadoc puuttuu.
tag.continuation.indent=Jatkorivin on väärä sisennystason, odotettu taso olisi {0} .
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ javadoc.writeTag={0}={1}
javadoc.wrong.singleton.html.tag=Le commentaire Javadoc à la colonne {0} ne peut être analysé. Il est interdit de fermer les balises HTML singleton. Balise : {1}
non.empty.atclause=La balise javadoc doit avoir une description non-vide.
singleline.javadoc=Le commentaire Javadoc sur une seule ligne doit être sur plusieurs lignes.
summary.first.sentence=La première phrase de la javadoc est incomplète (le point est manquant) ou non présente.
summary.first.sentence=La première phrase de Javadoc manque d'une période de fin.
summary.javaDoc=Fragment de résumé interdit.
summary.javaDoc.missing=Résumé javadoc est manquant.
tag.continuation.indent=La continuation de la ligne a un niveau d''indentation incorrect, le niveau attendu doit être {0}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ javadoc.writeTag={0}={1}
javadoc.wrong.singleton.html.tag={0} 桁目の Javadoc コメントでパースエラーが発生しました。空要素の閉じタグは禁止されています。タグ: {1}。
non.empty.atclause=Javadoc タグには空でない説明文が必要です。
singleline.javadoc=単一行のJavadocコメントは、複数行にする必要があります。
summary.first.sentence=Javadoc の​​最初の文が不完全(ピリオドがない)か、または文がありません
summary.first.sentence=Javadocの最初の文には終了時がありません
summary.javaDoc=禁止された文言が概要に含まれています。
summary.javaDoc.missing=要約javadocがありません。
tag.continuation.indent=行継続のインデントのレベルが間違っています。期待されるレベルは {0} です。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ javadoc.writeTag={0}={1}
javadoc.wrong.singleton.html.tag=Javadoc comentário na coluna {0} tem analisar erro. É proibido fechar tags HTML únicas. Tag: {1}
non.empty.atclause=Na cláusula deve ter uma descrição não-vazia.
singleline.javadoc=De linha única Javadoc comentário deve ser multi-line.
summary.first.sentence=Primeira frase do Javadoc está incompleta (período está faltando) ou não está presente.
summary.first.sentence=A primeira frase de Javadoc falta um período final.
summary.javaDoc=Fragmento resumo Proibida.
summary.javaDoc.missing=Sumário javadoc está ausente.
tag.continuation.indent=Continuação de linha têm nível de recuo incorreto, nível esperado deve ser {0}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ javadoc.writeTag={0}={1}
javadoc.wrong.singleton.html.tag=Sütununda Javadoc comment {0} hatası ayrıştırmak vardır. Bu singleton HTML etiketleri kapatmak için yasaktır. Etiket: {1}
non.empty.atclause=At-fıkra boş olmayan bir tanım olması gerekir.
singleline.javadoc=Tek satır Javadoc comment multi-line olmalıdır.
summary.first.sentence=Javadoc ilk cümlesi (dönem eksik) veya mevcut eksik.
summary.first.sentence=Javadoc'un ilk cümlesi biten bir süre eksik.
summary.javaDoc=Yasak özeti fragmanı.
summary.javaDoc.missing=Özet javadoc eksik.
tag.continuation.indent=Çizgi devamı yanlış girinti düzeyine sahip, beklenen seviyede olmalıdır {0}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ javadoc.writeTag={0}={1}
javadoc.wrong.singleton.html.tag=Javadoc 第 {0} 个字符解析错误。HTML 标签: {1} 不需要闭合。
non.empty.atclause=@标签应有非空说明。
singleline.javadoc=该Javadoc注释应为多行的。
summary.first.sentence=Javadoc 首句应以句号结尾
summary.first.sentence=Javadoc的第一句缺少一个结束时期
summary.javaDoc=禁止出现的首行内容。
summary.javaDoc.missing=缺少摘要javadoc。
tag.continuation.indent=Javadoc 缩进级别错误,应为 {0} 个缩进符。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ public void testIncorrect() throws Exception {
"47: " + getCheckMessage(MSG_SUMMARY_JAVADOC),
"53: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
"58: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
"58: " + getCheckMessage(MSG_SUMMARY_JAVADOC),
"69: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
"83: " + getCheckMessage(MSG_SUMMARY_JAVADOC),
"103: " + getCheckMessage(MSG_SUMMARY_JAVADOC_MISSING),
Expand Down

0 comments on commit 26dfacd

Please sign in to comment.