diff options
Diffstat (limited to 'doc/docblocks.doc')
| -rw-r--r-- | doc/docblocks.doc | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index a427b76..8e99669 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -513,8 +513,9 @@ Here is an example VHDL file with doxygen comments: for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. \endlatexonly -As of VHDL 2008 it is also to use `/‍*` type comments. Doxygen will handle `/‍* ... *‍/` -as plain comments and `/‍*! ... *‍/` comments as special doxygen comments with documentaton. +As of VHDL 2008 it is also possible to use `/‍*` style comments. +Doxygen will handle `/‍* ... *‍/`as plain comments and `/‍*! ... *‍/` +style comments as special comments to be parsed by doxygen. To get proper looking output you need to set \ref cfg_optimize_output_vhdl "OPTIMIZE_OUTPUT_VHDL" to \c YES in the |