Docs: improvements for "references - phpdoc - tags - property[<-read|-write>]" #2407
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.
I've combined the contents of the
@property
,@property-read
and@property-write
pages into one documentation page as it makes more sense to read about these tags together.The added benefit is, that this removed some (near) duplication in the documentation.
Note:
@property
documentation page being adjusted for the purposes of the TOC.@property-read
and@property-write
pages still exist, they will now just show the same contents as the@property
page.Summary:
Syntax:
@property-read
and@property-write
.Description:
As the link text starts with an underscore, I wasn't sure having those links at the bottom of the page would work as there they would need to be prefixed with an underscore, so, in this case, for these specific links, I've left them inline.
Effects in phpDocumentor:
@property-read
and@property-write
.Examples:
Other:
Ref: https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-tags.md#510-property