diff options
author | Charles Edward Pax <charles.pax@gmail.com> | 2017-07-27 21:27:23 +0800 |
---|---|---|
committer | Charles Edward Pax <charles.pax@gmail.com> | 2017-07-27 21:27:23 +0800 |
commit | c16ee2dbe57ff77fcd3fdacbe61918c04b391a26 (patch) | |
tree | e3e5b2b1a05a4c0e92685dc3f638cb61908a10bb /src | |
parent | c9180e0d8a91fae476fc63846f387edd9466aa64 (diff) |
Doxygen comments.
Diffstat (limited to 'src')
-rw-r--r-- | src/exec.h | 10 | ||||
-rw-r--r-- | src/file.h | 10 | ||||
-rw-r--r-- | src/filter.h | 10 | ||||
-rw-r--r-- | src/format.h | 10 | ||||
-rw-r--r-- | src/lex.h | 2 | ||||
-rw-r--r-- | src/maps.h | 2 | ||||
-rw-r--r-- | src/subtotal.h | 2 | ||||
-rw-r--r-- | src/vmtbl.h | 2 | ||||
-rw-r--r-- | src/xmalloc.h | 2 |
9 files changed, 21 insertions, 29 deletions
@@ -36,12 +36,10 @@ *******************************************************************************/ /** - * @file exec.h - * @author Andrés Martinelli <andmarti@gmail.com> - * @date 2017-07-18 - * @brief TODO Write a brief file description. - * - * TODO Write a longer file description here. + * \file exec.h + * \author Andrés Martinelli <andmarti@gmail.com> + * \date 2017-07-18 + * \brief Header file for exec.c */ int exec_cmd (char * line); @@ -36,12 +36,10 @@ *******************************************************************************/ /** - * @file file.h - * @author Andrés Martinelli <andmarti@gmail.com> - * @date 2017-07-18 - * @brief TODO Write a brief file description. - * - * TODO Write a longer file description here. + * \file file.h + * \author Andrés Martinelli <andmarti@gmail.com> + * \date 2017-07-18 + * \brief Header file for file.c */ #include "freeze.h" diff --git a/src/filter.h b/src/filter.h index 570d1c2..212fd13 100644 --- a/src/filter.h +++ b/src/filter.h @@ -36,12 +36,10 @@ *******************************************************************************/ /** - * @file filter.h - * @author Andrés Martinelli <andmarti@gmail.com> - * @date 2017-07-18 - * @brief TODO Write a tbrief file description. - * - * TODO Write a longer file description here. + * \file filter.h + * \author Andrés Martinelli <andmarti@gmail.com> + * \date 2017-07-18 + * \brief Header file for filter.c */ struct filter_item { diff --git a/src/format.h b/src/format.h index 9dd4bf1..8d0c75f 100644 --- a/src/format.h +++ b/src/format.h @@ -36,12 +36,10 @@ *******************************************************************************/ /** - * @file format.h - * @author Andrés Martinelli <andmarti@gmail.com> - * @date 2017-07-18 - * @brief TODO Write a tbrief file description. - * - * TODO Write a longer file description here. + * \file format.h + * \author Andrés Martinelli <andmarti@gmail.com> + * \date 2017-07-18 + * \brief Header file for format.c */ int format(char *fmt, int lprecision, double val, char *buf, int buflen); @@ -39,7 +39,7 @@ * \file lex.h * \author Andrés Martinelli <andmarti@gmail.com> * \date 2017-07-18 - * \brief Header file lex.h + * \brief Header file lex.c */ int yylex(); @@ -39,7 +39,7 @@ * \file maps.h * \author Andrés Martinelli <andmarti@gmail.com> * \date 2017-07-18 - * \brief Header file for maps.h + * \brief Header file for maps.c */ #include "input.h" diff --git a/src/subtotal.h b/src/subtotal.h index a7e1306..6870e00 100644 --- a/src/subtotal.h +++ b/src/subtotal.h @@ -39,7 +39,7 @@ * \file subtotal.h * \author Andrés Martinelli <andmarti@gmail.com> * \date 2017-07-18 - * \brief Header file for subtotal.h + * \brief Header file for subtotal.c */ int subtotal(int r, int c, int rf, int cf, int group_col, char * operation, int ope_col, int replace_subtotals); diff --git a/src/vmtbl.h b/src/vmtbl.h index 555cedd..8a672bd 100644 --- a/src/vmtbl.h +++ b/src/vmtbl.h @@ -39,7 +39,7 @@ * \file vmtbl.h * \author Andrés Martinelli <andmarti@gmail.com> * \date 2017-07-18 - * \brief Header file for vmtbl.h + * \brief Header file for vmtbl.c */ void checkbounds(int * rowp, int * colp); diff --git a/src/xmalloc.h b/src/xmalloc.h index b2fe095..294d468 100644 --- a/src/xmalloc.h +++ b/src/xmalloc.h @@ -39,7 +39,7 @@ * \file xmalloc.h * \author Andrés Martinelli <andmarti@gmail.com> * \date 2017-07-18 - * \brief Header file for xmalloc.h + * \brief Header file for xmalloc.c */ char * scxmalloc(unsigned n); |