Skip to content

Commit fb62856

Browse files
committed
Merge pull request #380 from RogerWebb/patch-2
Added tip for those using other programs (like Doxygen) that use annotati
2 parents 082823c + 4e96fa1 commit fb62856

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

book/doctrine.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,15 @@ in a number of different formats including YAML, XML or directly inside the
236236
The table name is optional and if omitted, will be determined automatically
237237
based on the name of the entity class.
238238

239+
.. tip::
240+
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.
247+
239248
Doctrine allows you to choose from a wide variety of different field types,
240249
each with their own options. For information on the available field types,
241250
see the :ref:`book-doctrine-field-types` section.

0 commit comments

Comments
 (0)