Further documentation improvements

2 files changed, 22 insertions, 21 deletions

diff --git a/doc/documentation.doxygen.in b/doc/documentation.doxygen.in
index 7753f15..c1c18ee 100644
--- a/doc/documentation.doxygen.in
+++ b/doc/documentation.doxygen.in
@@ -1005,7 +1005,7 @@ INCLUDE_FILE_PATTERNS  =
 # 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. 
diff --git a/xtract/libxtract.h b/xtract/libxtract.h
index 0c1ee75..5de0e32 100644
--- a/xtract/libxtract.h
+++ b/xtract/libxtract.h
@@ -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 @@ enum return_codes_ {
  * 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
  * 
  */