valkyrjaio / valkyrja-java / 33830334614

100%

push

github

[Event] docs: Remove the doc comment from the listener provider contract (#208)

# Description

The `ListenerProviderContract` doc comment states that PHP declares
`getListenerClasses()` and `getListeners()` as
static methods, and that Java diverges. PHP declares both as instance
methods:

```php
public function getListenerClasses(): array;
public function getListeners(): array;
```

There is no divergence, so the comment records one that does not exist.
A reader who trusts the comment writes a static
method in the PHP port.

The whole doc comment goes, and not the false sentence alone.
`COMMENTS.md` states that a contract carries no doc
comment, because the name and the segment say what the type is.
`HttpRouteProviderContract` and
`CliRouteProviderContract` already declare bare.

## 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 functionality)_
- [ ] Breaking change _(fix or feature that would cause existing
functionality to change)_
- [x] Documentation improvement

## Changes

- **`ListenerProviderContract.java`** — removed the type-level doc
comment. The method doc comments are unchanged.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

1891 of 1891 branches covered (100.0%)

Branch coverage included in aggregate %.

6939 of 6939 relevant lines covered (100.0%)

4.32 hits per line