cakephp-api-docs icon indicating copy to clipboard operation
cakephp-api-docs copied to clipboard

cake 5: Support parameters with only type hints

Open othercorey opened this issue 4 years ago • 1 comments

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?

image

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).

othercorey avatar Sep 23 '21 03:09 othercorey

The current behavior is to use the type hint if no annotation exists and all parameters are listed in the block.

These are often just duplicates of the data in the function signature.

othercorey avatar Sep 23 '21 03:09 othercorey