Mercurial > hg > libxtract
changeset 21:44e1a5363745
Further documentation improvements
| author | Jamie Bullock <jamie@postlude.co.uk> |
|---|---|
| date | Thu, 12 Oct 2006 11:59:11 +0000 |
| parents | 8b8d4f1c5fb6 |
| children | bc44e56e6c81 |
| files | doc/documentation.doxygen.in xtract/libxtract.h |
| diffstat | 2 files changed, 22 insertions(+), 21 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/documentation.doxygen.in Tue Oct 10 12:29:39 2006 +0000 +++ b/doc/documentation.doxygen.in Thu Oct 12 11:59:11 2006 +0000 @@ -1005,7 +1005,7 @@ # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = +PREDEFINED = XTRACT # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded.
--- a/xtract/libxtract.h Tue Oct 10 12:29:39 2006 +0000 +++ b/xtract/libxtract.h Thu Oct 12 11:59:11 2006 +0000 @@ -36,8 +36,9 @@ extern "C" { #endif -/** - * \file libxtract.h: main header file and API definition +/** + * \file libxtract.h + * \brief main header file and API definition */ #include "xtract_scalar.h" @@ -149,27 +150,27 @@ * Memory for this array must be allocated and freed by the calling * function. * - * All functions return an integer error code as descibed in the enumeration - * return_codes_ + * All functions return an integer error code as descibed in the enumeration + * return_codes_ * - * The preprocessor macro: XTRACT must be defined before this can be used + * The preprocessor macro: XTRACT must be defined before this can be used * * example:<br> - * - * #include <stdio.h> - * #define XTRACT - * #include "libxtract.h" - * - * main () { - * float values[] = {1.0, 2.0, 3.0, 4.0, 5.0}; - * int N = 5; - * float mean; - * - * xtract[MEAN]((void *)values, N, NULL, &mean); - * - * printf("Mean = %.2f\n", mean); - * } - * + * \verbatim +#include <stdio.h> +#define XTRACT +#include "libxtract.h" + +main () { +float values[] = {1.0, 2.0, 3.0, 4.0, 5.0}; +int N = 5; +float mean; + +xtract[MEAN]((void *)values, N, NULL, &mean); + +printf("Mean = %.2f\n", mean); +} +\endverbatim * The calling function may additionally make some tests against the value returned by xtract * */