Skip to content

Document src with Doppar-style PHPDoc blocks - #6

Merged
techmahedy merged 1 commit into
mainfrom
docs/doppar-phpdoc
Oct 27, 2026
Merged

techmahedy merged 1 commit into
mainfrom
docs/doppar-phpdoc

Conversation

@abdulmajidcse

@abdulmajidcse abdulmajidcse commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

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 @param per parameter in signature order, and an @return on 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 @var annotations 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-check all 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's View::render().
  • Component::dispatch(), dispatchTo() and dispatchSelf() now use @param mixed ...$params instead of list<mixed>, which is the correct way to write a variadic.
  • The Op::REORDER summary is inferred from its name alone, since DiffEngine never emits it.

Please merge with Squash and merge.

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.

@techmahedy techmahedy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues from my end, @abdulmajidcse thanks

@techmahedy
techmahedy requested a review from xentixar October 27, 2026 04:32

@xentixar xentixar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks !!

@techmahedy
techmahedy merged commit c3039cc into main Oct 27, 2026
3 checks passed
@abdulmajidcse
abdulmajidcse deleted the docs/doppar-phpdoc branch October 27, 2026 06:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants