4760
93%
master: 94%

Ran 03 Dec 2018 09:33AM UTC

Jobs 1

Files 90

Run time 9s

Badge

Embed ▾

pending completion

Build # 4760

Build Type

Pull #934

travis-ci

Committed by

web-flow

Commit Message

checkstyle: allow missing javadoc for private methods

The use of every language feature has a trade-off. In the case of
javadocs, they allow readers to understand the behavior of a method,
without needing to look at the source code of the method itself.
However, they also present an additional maintenance cost as they need
to be kept up to date.

In the case of private methods, javadocs don't really present any
advantages, as since the methods are _private_, readers can't read the
javadoc without also reading the source code of the method itself.

Furthermore, private methods are usually used for implementation details
of an algorithm, where full understanding can't be gained from just
reading the javadoc, since it is highly coupled to the details of the
full algorithm and hence the reader would need to read the source code
of the whole file anyway.

Some examples in the code base where enforcing javadocs on private
methods don't really add much value include the
assertCommandSuccess()/assertCommandFailure() private methods in
AddCommandSystemTest, DeleteCommandSystemTest etc. where the javadocs
are simply a description of their source code in prose.

Let's relax the checkstyle configuration to allow private methods with a
missing javadoc.

Pull Request Pull Request #934: checkstyle: allow missing javadoc for private methods

Run Details

1433 of 1544 relevant lines covered (92.81%)

0.93 hits per line

Jobs

ID	Job ID	Ran	Files	Coverage
1	4760.1	03 Dec 2018 09:33AM UTC	0	92.81	Travis Job 4760.1

Source Files on build 4760

Detailed source file information is not available for this build.

se-edu / addressbook-level4 / 4760
93%
master: 94%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 4760

se-edu / addressbook-level4 / 4760 93% master: 94%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 4760

se-edu / addressbook-level4 / 4760
93%
master: 94%

README BADGES
x