diff options
| author | Dimitri van Heesch <doxygen@gmail.com> | 2019-12-22 17:48:17 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-22 17:48:17 (GMT) |
| commit | d244b46490a6c5e1d9179c46683811ad56557809 (patch) | |
| tree | 696d43a393d5a2785448e0dcb0566f57a000b70c /doc/docblocks.doc | |
| parent | a6da9a48ad520206462632496fc4c83d72bffe5a (diff) | |
| parent | 786f8c9d2b55ebcde9e2702fc9dfc8ab1e4609b6 (diff) | |
| download | Doxygen-d244b46490a6c5e1d9179c46683811ad56557809.zip Doxygen-d244b46490a6c5e1d9179c46683811ad56557809.tar.gz Doxygen-d244b46490a6c5e1d9179c46683811ad56557809.tar.bz2 | |
Merge branch 'master' into feature/bug_550158
Diffstat (limited to 'doc/docblocks.doc')
| -rw-r--r-- | doc/docblocks.doc | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 9d14f6e..8e99669 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -513,6 +513,10 @@ 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 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 configuration file. This will also affect a number of other settings. When they |