Repository navigation
Document src with Doppar-style PHPDoc blocks - #6
Merged
Merged
Conversation
Every method, property and class constant in src/ now carries a docblock in the format from the Doppar contribution guide: a one-line summary, a blank line, one @PARAM per parameter and an @return on everything but constructors. Existing prose and richer types are kept. Comment-only change; no code is touched.
abdulmajidcse
force-pushed
the
docs/doppar-phpdoc
branch
from
October 26, 2026 17:19
dd2d93a to
132d2a7
Compare
techmahedy
approved these changes
Oct 27, 2026
techmahedy
left a comment
Member
There was a problem hiding this comment.
No issues from my end, @abdulmajidcse thanks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Every method, property and class constant in
src/now has a docblock in the format from the Doppar contribution guide: a one-line summary, a blank line, one@paramper parameter in signature order, and an@returnon everything except constructors (including@return void). There is one space between each tag and its type, with no column alignment.Existing prose and richer types (
class-string<Component>,array<string, mixed>, array shapes) are kept. One-line/** @var X */property comments are expanded to the full form. Inline//comments and inline@varannotations are untouched.This is a comment-only change, and the diff contains no code lines. A Reflection-based check confirms that all 207 methods, 31 properties, 8 constants and the 2 helper functions follow the format. PHPUnit (145 tests, 772 assertions), PHPStan and
cs-checkall pass on PHP 8.5.Worth a look while reviewing:
RippleViewController::render()has an untyped signature. I documented it as@return string, the same as the framework'sView::render().Component::dispatch(),dispatchTo()anddispatchSelf()now use@param mixed ...$paramsinstead oflist<mixed>, which is the correct way to write a variadic.Op::REORDERsummary is inferred from its name alone, sinceDiffEnginenever emits it.Please merge with Squash and merge.