You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently you can choose to hide child controllers and endpoints by using arrays in the controller. These aren't very friendly. As we're already using PHPDoc comments to show information to end users, we can also use it to hide it, by using something like an @hidden flag. Eg.
/** * This endpoint is hidden * @hidden */publicfunctiongetExampleAction() {...}
This can be extended to controllers once Issue #2 is completed.
The text was updated successfully, but these errors were encountered:
AyeAye\hidden - Hides the controller / endpoint from auto documentation
AyeAye\param - Override the @param if necessary
AyeAye\description - Override the description. Can be more verbose too
AyeAye\summary - Override summary (note: PHPDoc already differentiates summary / description so this should be implemented too
AyeAye\returns - Override the return value (note: need to add return value. This wasn't appropriate before as it would reveal class names etc)
Maybe others too, can look through PHPDoc documentation and work out what else is necessary.
Prior to annotations (and in addition to them), we should use the @ignore phpDocumentor tag. It's not desirable to have this as the only way to have this effect as it prevents the method appearing in phpDocumentor too. However, if you're not documenting the method in phpDocumentor, then you probably don't want it to appear in the API documentation either.
Annotations should allow this to be overridden so it does show though.
This methodology won't be compatible with the "manage it with arrays" method we currently have. We should leave fixing this until we add annotations and just wrap this into that.
Currently you can choose to hide child controllers and endpoints by using arrays in the controller. These aren't very friendly. As we're already using PHPDoc comments to show information to end users, we can also use it to hide it, by using something like an
@hidden
flag. Eg.This can be extended to controllers once Issue #2 is completed.
The text was updated successfully, but these errors were encountered: