From f1274b44ad4cb7b4c1a04893b5ad17f830600af4 Mon Sep 17 00:00:00 2001
From: albert-github <albert.tests@gmail.com>
Date: Fri, 23 Feb 2018 14:50:13 +0100
Subject: Documentation correction

- corrected tcl documentation in respect to use of param, has to be \param
- added to define documentation possibilities of \param and \return
---
 examples/define.h       |  4 +++-
 examples/tclexample.tcl | 16 ++++++++--------
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/examples/define.h b/examples/define.h
index c330447..0cd7ae3 100644
--- a/examples/define.h
+++ b/examples/define.h
@@ -10,7 +10,9 @@
 */
 
 /*! 
-   Computes the absolute value of its argument \a x.
+   \brief Computes the absolute value of its argument \a x.
+   \param x input value.
+   \returns absolute value of \a x.
 */
 #define ABS(x) (((x)>0)?(x):-(x))
 #define MAX(x,y) ((x)>(y)?(x):(y))
diff --git a/examples/tclexample.tcl b/examples/tclexample.tcl
index 6edef66..e512aee 100644
--- a/examples/tclexample.tcl
+++ b/examples/tclexample.tcl
@@ -10,7 +10,7 @@ exec tclsh "$0" "$@"
 #\code
 namespace eval ns {
   ## Documented proc \c ns_proc .
-  # param[in] arg some argument
+  # \param[in] arg some argument
   proc ns_proc {arg} {}
   ## Documented var \c ns_var .
   # Some documentation.
@@ -22,13 +22,13 @@ namespace eval ns {
     ## Destroy object.
     destructor {exit}
     ## Documented itcl method \c itcl_method_x .
-    # param[in] arg Argument
+    # \param[in] arg Argument
     private method itcl_method_x {arg}
     ## Documented itcl method \c itcl_method_y .
-    # param[in] arg Argument
+    # \param[in] arg Argument
     protected method itcl_method_y {arg} {}
     ## Documented itcl method \c itcl_method_z .
-    # param[in] arg Argument
+    # \param[in] arg Argument
     public method itcl_method_z {arg} {}
     ## Documented common itcl var \c itcl_Var .
     common itcl_Var
@@ -49,13 +49,13 @@ namespace eval ns {
     # Defined inside class
     variable oo_var
     ## \private Documented oo method \c oo_method_x .
-    # param[in] arg Argument
+    # \param[in] arg Argument
     method oo_method_x {arg} {}
     ## \protected Documented oo method \c oo_method_y .
-    # param[in] arg Argument
+    # \param[in] arg Argument
     method oo_method_y {arg} {}
     ## \public Documented oo method \c oo_method_z .
-    # param[in] arg Argument
+    # \param[in] arg Argument
     method oo_method_z {arg} {}
   }
 }
@@ -72,7 +72,7 @@ oo::define ns::oo_class {
 }
 
 ## Documented global proc \c glob_proc .
-# param[in] arg Argument
+# \param[in] arg Argument
 proc glob_proc {arg} {puts $arg}
 
 variable glob_var;#< Documented global var \c glob_var\
-- 
cgit v0.12