google / google/styleguide

Overly-strict description for single-line Javadoc at the Java Style Guide

Open
#66 0 comments 0 reactions 0 assignees View on GitHub
lang:java
Dominant language
HTML
Stars
39.6k
Forks
12.9k
Avg merge
42m
Merged PRs (30d)
15

Description

originally reported by Googlers ( @ekuefler ) at https://github.com/checkstyle/checkstyle/pull/1545 see all details there.

it is proved by report on Guava that style guide mean that inline tokes should be allowed in single line javadocs, but we need to change guide first to let Checkstyle change configuration. Checkstyle team need to be sure that we are right in interpretation of style guide.

Side note: detailed report on how Checkstyle cover all rules of Google Style guide could be found there - http://checkstyle.sourceforge.net/google_style.html

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.