Skip to content

Commit e2d5d9f

Browse files
committed
Tweaking note about annotations
1 parent fb62856 commit e2d5d9f

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

book/doctrine.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -238,12 +238,20 @@ in a number of different formats including YAML, XML or directly inside the
238238

239239
.. tip::
240240

241-
When using another library or program (ie. Doxygen) that uses annotations,
242-
you must use the @IgnoreAnnotation annotation to indicate which annotations
243-
Symfony and Doctrine should ignore. This annotation should be placed in the
244-
comment block of the class it applies to. Failing to do so may result in an
245-
Exception being thrown.
246-
Example: @IgnoreAnnotation("fn") will prevent "@fn ..." from throwing an Exception.
241+
When using another library or program (ie. Doxygen) that uses annotations,
242+
you must use the ``@IgnoreAnnotation`` annotation to indicate which annotations
243+
Symfony and Doctrine should ignore. This annotation should be placed in the
244+
comment block of the class it applies to. Failing to do so may result
245+
in an exception being thrown.
246+
247+
For example, to prevent the ``@fn`` annotation from throwing an exception,
248+
add the following::
249+
250+
/**
251+
* @IgnoreAnnotation("fn")
252+
*
253+
*/
254+
class Product
247255

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

0 commit comments

Comments
 (0)