cakephp / cakephp/cakephp-api-docs
cake 5: Support parameters with only type hints
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 29
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Description
Starting with cake 5, some function parameters won't have matching docblock @param annotations.
Do we want to still list these parameters in the parameter block with no description or should we hide them?
These parameters won't have a matching annotation because PHP 8 allows union types that fully documents the allowed types and the parameter name is self-documenting (the annotation description isn't helpful).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how CakePHP 5 parameters with PHP 8 type hints are represented in the API documentation. Resolve whether parameters without matching @param annotations should appear with empty descriptions or be hidden, then add coverage for the selected behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100