valkyrjaio / valkyrja-java / 32207913116

100%

push

github

[Comment] docs: Remove the restating doc blocks from type declarations (#173)

# Description

Golden rule 15 forbids a doc comment on a type declaration, because the
name and the segment already say what the type is. A test fixture is the
one exception, and it carries a single line that says what the fixture
is for. This removes the blocks that break that rule and add nothing.

Ten declarations each carried one sentence that restated the name.
`Config` said "Immutable application configuration", `ContainerContract`
said "Contract for the dependency injection container", and `Peer` said
"Immutable PeerContract implementation". A record already shows that it
is immutable, and a contract in a `contract` segment already shows that
it is a contract, so none of these sentences stated anything the
declaration does not.

Eleven fixtures kept their opening sentence. The detail they dropped
described the branch each fixture drives, which the test that uses the
fixture shows.

Spotless collapses a short block to a single line, so each retained
fixture block is now one line rather than three.

This is a partial pass. The blocks that carry a fact the declaration
cannot show stay for now — the middleware stage contracts that state
when each stage runs, `RouteCollectionContract` that states the shape of
the service map, and the entry points that document their bootstrap
model. Rule 15 moves that material to the component documentation rather
than deleting it, so those blocks need the documentation written first.

Test classes are out of scope. Rule 15 names a test fixture as the
exception and says nothing about a test class.

The diff contains no executable change. Spotless passes and all 1,984
tests pass.

## Types of changes

- [ ] Improvement _(non-breaking change which improves code)_
- [ ] Bug fix _(non-breaking change which fixes an issue)_
- [ ] New feature _(non-breaking change which adds functionality)_
- [ ] Deprecation _(breaking change which removes func... (continued)

1891 of 1891 branches covered (100.0%)

Branch coverage included in aggregate %.

6866 of 6866 relevant lines covered (100.0%)

4.32 hits per line