Escape annotations in comments #13240
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
cmfcmf
commented
Jan 4, 2015
| Q | A |
|---|---|
| Fixed tickets | --- |
| Referenced tickets | #13089 |
| License | MIT |
| @@ -248,7 +248,7 @@ public function getBundle($name, $first = true) | |||
| * | |||
| * The resource name must follow the following pattern: | |||
| * | |||
| * @<BundleName>/path/to/a/file.something | |||
| * "@BundleName/path/to/a/file.something" | |||
| * | |||
| * where BundleName is the name of the bundle | |||
| * and the remaining part is the relative path in the bundle. | |||
There was a problem hiding this comment.
this complete doc block should actually be replaced with {@inheritDoc}
There was a problem hiding this comment.
This docblock has one RuntimeException more than the docblock in the interface. Shall I still replace it? Shall I add the additional exception to the docblock of the interface?
There was a problem hiding this comment.
/**
* {@inheritDoc}
*
* @throws RuntimeException When ...
*/
There was a problem hiding this comment.
Done. I've merged the two docblocks.
There was a problem hiding this comment.
The Fabbot says I should use {@inheritDoc} with a lower-cased d. Which one is correct now?
There was a problem hiding this comment.
@cmfcmf The lowercased one would have been correct.
|
Thank you @cmfcmf. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.