Documentation: review of the @see
tags
#532
Merged
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.
Pull Request Type
This is a:
Context
Improving the generated documentation for the website.
Detailed Description
Docs: use @link tags for external references
Docs: use parentheses when referencing a function in a @see tag
Docs: use fully qualified names in @see tags [1]
... for Requests native classes to prevent confusion.
Docs: use fully qualified names in @see tags [2]
... for external (PHP native) classes.
Previously, APIGen would add an incorrect link for this reference, which had to be removed for each website update.
With this change, that manual update can now hopefully be prevented.
Quality assurance
Documentation
For new features:
examples
directory.docs
directory.If the documentation is in a new markdown file, I have added a link to this new file to the Docs folder
README.md
file.