diff options
author | Dimitri van Heesch <doxygen@gmail.com> | 2019-12-23 13:18:30 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-12-23 13:18:30 (GMT) |
commit | 9cafaedb50c8e430cc8c34ef44a84bc1dbcb64ad (patch) | |
tree | ffee9d6d930022c55710bc0931d0da6a77be27f0 /doc/docblocks.doc | |
parent | c9284a1aae6e876e0399c4757837bec3563751e2 (diff) | |
parent | ecc4f838db18336c4afbc6dabb1a8edbc6d8bbd0 (diff) | |
download | Doxygen-9cafaedb50c8e430cc8c34ef44a84bc1dbcb64ad.zip Doxygen-9cafaedb50c8e430cc8c34ef44a84bc1dbcb64ad.tar.gz Doxygen-9cafaedb50c8e430cc8c34ef44a84bc1dbcb64ad.tar.bz2 |
Merge branch 'master' into spelling
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 |