diff options
| author | albert-github <albert.tests@gmail.com> | 2018-02-23 13:50:13 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2018-02-23 13:50:13 (GMT) |
| commit | f1274b44ad4cb7b4c1a04893b5ad17f830600af4 (patch) | |
| tree | 3335dc903bfdfe3e7bb5cea7a02b86e7b6043148 /examples/define.h | |
| parent | b6f01ff09b17e5c2288f2418ef0a8f074456c357 (diff) | |
| download | Doxygen-f1274b44ad4cb7b4c1a04893b5ad17f830600af4.zip Doxygen-f1274b44ad4cb7b4c1a04893b5ad17f830600af4.tar.gz Doxygen-f1274b44ad4cb7b4c1a04893b5ad17f830600af4.tar.bz2 | |
Documentation correction
- corrected tcl documentation in respect to use of param, has to be \param
- added to define documentation possibilities of \param and \return
Diffstat (limited to 'examples/define.h')
| -rw-r--r-- | examples/define.h | 4 |
1 files changed, 3 insertions, 1 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)) |