PSR2/SwitchDeclaration: improve XML documentation #1049
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.
Description
PSR2/SwitchDeclaration: update doc as case indentation is not checked
The sniff no longer checks
case
keyword indentation as of commit 4a39005, but the corresponding XML documentation was not updated. This commit aligns the documentation with the current sniff behavior by removing mentions ofcase
indentation checks.PSR2/SwitchDeclaration: update doc as case body should be non-empty
This commit updates the valid and invalid code examples in a
<code_comparison>
block, as theThere must be a comment when fall-through is intentional in a non-empty case body
error is only triggered for non-emptycase
bodies. It also fixes the positioning of the<em>
tags in the modified code examples.PSR2/SwitchDeclaration: improve XML documentation
<standard>
blocks for each error triggered by thesniff.
PSR2/SwitchDeclaration: add missing errors to the XML documentation
This commit adds four sniff errors not previously documented to the
PSR2.ControlStructures.SwitchDeclaration
sniff XML documentation.Suggested changelog entry
PSR2.ControlStructures.SwitchDeclaration: minor fixes and improvements to the XML documentation
Types of changes
PR checklist