summaryrefslogtreecommitdiffstats
path: root/doc/docblocks.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <doxygen@gmail.com>2020-03-22 18:52:13 (GMT)
committerDimitri van Heesch <doxygen@gmail.com>2020-03-22 18:52:13 (GMT)
commit58ea5cf320f08ae2ec3e5fbd02d82ca0ba4477a7 (patch)
tree276459ef85aff5edeef7e229cf7e66ec47e3d008 /doc/docblocks.doc
parent5f192d9830bc32022b64715ad441b3c09438d8ff (diff)
parent48a7afc0caf69857a42b0fe1963db3440cb4000f (diff)
downloadDoxygen-58ea5cf320f08ae2ec3e5fbd02d82ca0ba4477a7.zip
Doxygen-58ea5cf320f08ae2ec3e5fbd02d82ca0ba4477a7.tar.gz
Doxygen-58ea5cf320f08ae2ec3e5fbd02d82ca0ba4477a7.tar.bz2
Merge branch 'remove_tcl'
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r--doc/docblocks.doc72
1 files changed, 3 insertions, 69 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index 23933c7..6c1edae 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -31,9 +31,9 @@ additional markings, so doxygen knows it is a piece of structured text that
needs to end up in the generated documentation. The \ref cppblock "next" section
presents the various styles supported by doxygen.
-For Python, VHDL, Fortran, and Tcl code there are different commenting
-conventions, which can be found in sections \ref pythonblocks, \ref vhdlblocks,
-\ref fortranblocks, and \ref tclblocks respectively.
+For Python, VHDL, and Fortran code there are different commenting
+conventions, which can be found in sections \ref pythonblocks, \ref vhdlblocks, and
+\ref fortranblocks respectively.
\subsection cppblock Comment blocks for C-like languages (C/C++/C#/Objective-C/PHP/Java)
@@ -564,72 +564,6 @@ C> input parameter
end function A
\endcode
-\subsection tclblocks Comment blocks in Tcl
-
-Doxygen documentation can be included in normal Tcl comments.
-
-To start a new documentation block start a line with \c ## (two hashes).
-All following comment lines and continuation lines will be added to this
-block. The block ends with a line not starting with a \c # (hash sign).
-
-A brief documentation can be added with \c ;#< (semicolon, hash and
-less-than sign). The brief documentation also ends at a line not starting
-with a \c # (hash sign).
-
-Inside doxygen comment blocks all normal doxygen markings are supported.
-The only exceptions are described in the following two paragraphs.
-
-If a doxygen comment block ends with a line containing only
-\c #\\code or \c #\@code all code until a line only containing \c #\\endcode
-or \c #\@endcode is added to the generated documentation as code block.
-
-If a doxygen comment block ends with a line containing only
-\c #\\verbatim or \c #\@verbatim all code until a line only containing
-\c #\\endverbatim or \c #\@endverbatim is added verbatim to the generated
-documentation.
-
-To detect namespaces, classes, functions and variables the following
-Tcl commands are recognized. Documentation blocks can be put on the lines
-before the command.
-
-<ul>
-<li><tt>namespace eval ..</tt> Namespace
-<li><tt>proc ..</tt> Function
-<li><tt>variable ..</tt> Variable
-<li><tt>common ..</tt> Common variable
-<li><tt>itcl::class ..</tt> Class
-<li><tt>itcl::body ..</tt> Class method body definition
-<li><tt>oo::class create ..</tt> Class
-<li><tt>oo::define ..</tt> OO Class definition
-<li><tt>method ..</tt> Class method definitions
-<li><tt>constructor ..</tt> Class constructor
-<li><tt>destructor ..</tt> Class destructor
-<li><tt>public ..</tt> Set protection level
-<li><tt>protected ..</tt> Set protection level
-<li><tt>private ..</tt> Set protection level
-</ul>
-
-<!--
-To use your own keywords you an map these keyword to the recognized commands
-using the \ref cfg_tcl_subs "TCL_SUBST" entry in the configuration file.
-The entry contain a list of word-keyword mappings. To use the itcl::*
-commands without the leading namespace use p.e.:
-
-\verbatim TCL_SUBST = class itcl:class body itcl:body \endverbatim
--->
-
-Following is an example using doxygen style comments:
-
-\include tclexample.tcl
- \htmlonly
- Click <a href="examples/tclexample/html/index.html">here</a>
- for the corresponding HTML documentation that is generated by doxygen.
- \endhtmlonly
- \latexonly
- See \hyperlink{tcl_example}{TCL example}
- for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
- \endlatexonly
-
\section docstructure Anatomy of a comment block