diff options
| author | albert-github <albert.tests@gmail.com> | 2019-12-11 19:32:22 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2019-12-11 19:32:22 (GMT) |
| commit | ac303e2ff9e3a66cbe128c30c2986ed92851ceb6 (patch) | |
| tree | 56a28b57acc18bcdaa3c6f3bbc27597ef681aaa0 /doc/docblocks.doc | |
| parent | 1a5bbadb43b2d30e338d26a0d495b60e2b12f704 (diff) | |
| download | Doxygen-ac303e2ff9e3a66cbe128c30c2986ed92851ceb6.zip Doxygen-ac303e2ff9e3a66cbe128c30c2986ed92851ceb6.tar.gz Doxygen-ac303e2ff9e3a66cbe128c30c2986ed92851ceb6.tar.bz2 | |
issue #7436 Incorrect handling of block comments in VHDL
Added some documentation
Diffstat (limited to 'doc/docblocks.doc')
| -rw-r--r-- | doc/docblocks.doc | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 9d14f6e..a427b76 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -513,6 +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. + To get proper looking output you need to set \ref cfg_optimize_output_vhdl "OPTIMIZE_OUTPUT_VHDL" to \c YES in the configuration file. This will also affect a number of other settings. When they |