diff options
| author | Dimitri van Heesch <doxygen@gmail.com> | 2019-12-12 21:21:40 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <doxygen@gmail.com> | 2019-12-12 21:21:40 (GMT) |
| commit | 5698b7556966fe39c1a808f609a3e14bd648786d (patch) | |
| tree | a7eb8c8768d5026f93d478203884dbaff23fbdc8 /doc/docblocks.doc | |
| parent | ec2f456688dcc33008f7649d33930b49a71dff30 (diff) | |
| download | Doxygen-5698b7556966fe39c1a808f609a3e14bd648786d.zip Doxygen-5698b7556966fe39c1a808f609a3e14bd648786d.tar.gz Doxygen-5698b7556966fe39c1a808f609a3e14bd648786d.tar.bz2 | |
Minor fixes
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 |