Skip to content

Commit 4e96fa1

Browse files
committed
Edited in response to stof's note. Used @fn instead of @param in the example and added a note letting the reader know where the @IgnoreAnnotation annotation should be placed.
1 parent 5e82e1b commit 4e96fa1

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

book/doctrine.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,9 +234,10 @@ in a number of different formats including YAML, XML or directly inside the
234234

235235
When using another library or program (ie. Doxygen) that uses annotations,
236236
you must use the @IgnoreAnnotation annotation to indicate which annotations
237-
Symfony and Doctrine should ignore. Failing to do so may result in an
237+
Symfony and Doctrine should ignore. This annotation should be placed in the
238+
comment block of the class it applies to. Failing to do so may result in an
238239
Exception being thrown.
239-
Example: @IgnoreAnnotation("param") will prevent "@param ..." from throwing an Exception.
240+
Example: @IgnoreAnnotation("fn") will prevent "@fn ..." from throwing an Exception.
240241

241242
Doctrine allows you to choose from a wide variety of different field types,
242243
each with their own options. For information on the available field types,

0 commit comments

Comments
 (0)