Added tip for those using other programs (like Doxygen) that use annotati #380
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
…tations letting the user know that the @IgnoreAnnotation annotation is necessary to prevent an Exception from being thrown.
| you must use the @IgnoreAnnotation annotation to indicate which annotations | ||
| Symfony and Doctrine should ignore. Failing to do so may result in an | ||
| Exception being thrown. | ||
| Example: @IgnoreAnnotation("param") will prevent "@param ..." from throwing an Exception. |
There was a problem hiding this comment.
You should use another example as @param is already ignored by default.
…example and added a note letting the reader know where the @IgnoreAnnotation annotation should be placed.
weaverryan
added a commit
that referenced
this pull request
Jun 14, 2011
Added tip for those using other programs (like Doxygen) that use annotati
|
I think this is a great note and I've merged it in. The tricky part is that this really applies to all annotations - and a case could be made for this to be in the validation chapter as well. So, I'm not totally sure we have it in the right place yet, but it's at least in a good place. Thanks! |
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.
Added tip for those using other programs (like Doxygen) that use annotations letting the user know that the @IgnoreAnnotation annotation is necessary to prevent an Exception from being thrown.