Improved documentation of several files.

diff --git a/rpp/doc/api/doxygen.conf b/rpp/doc/api/doxygen.conf
index 61a3ef1fd984f1e6a0d7a291fad249a6172621ec..2c94305ddc427fe8164613c40c023658a2f7ed43 100644 (file)
--- a/rpp/doc/api/doxygen.conf
+++ b/rpp/doc/api/doxygen.conf
@@ -648,7 +648,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = ../include/rpp/
+INPUT                  = ../../include/ ../../include/rpp/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -1242,7 +1242,7 @@ COMPACT_LATEX          = NO
 # by the printer. Possible values are: a4, letter, legal and
 # executive. If left blank a4wide will be used.
 
-PAPER_TYPE             = a4
+PAPER_TYPE             = letter
 
 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
 # packages that should be included in the LaTeX output.

diff --git a/rpp/include/base.h b/rpp/include/base.h
index 8e9b66ac9d6941a9e074638379a077020f1a322c..c5be2a6185a599423c5c438a8811aafce2211106 100644 (file)
--- a/rpp/include/base.h
+++ b/rpp/include/base.h
@@ -16,13 +16,29 @@
 #include "types.h"
 #include "binary.h"
 
+
 // General IO directives
+/**
+ * Maximum length of system buffers.
+ */
 #define MAX_BUFFER_LEN 128
 
+
 // Debug directives
-#define DEBUG
+/**
+ * Macro to mark unused variables.
+ */
 #define UNUSED(x) (void)(x)
+
+/**
+ * General debug directive.
+ */
+#define DEBUG
+
 #ifdef DEBUG
+/**
+ * Macro to mark debug statements.
+ */
 #  define D(x) x
 #else
 #  define D(x)

diff --git a/rpp/include/binary.h b/rpp/include/binary.h
index 1495f62f6a8326df55640959afad79de38c24aa7..0912fb7eb6c1b6bb9dda32c46fbbfc611cd2c2c7 100644 (file)
--- a/rpp/include/binary.h
+++ b/rpp/include/binary.h
@@ -109,6 +109,11 @@
  * FIXME: Document.
  */
 #define __val2mfld(mask,val) (((mask)&~((mask)<<1))*(val)&(mask))
+
+
+/**
+ * FIXME: Document.
+ */
 #define __mfld2val(mask,val) (((val)&(mask))/((mask)&~((mask)<<1)))
 
 

diff --git a/rpp/include/sys/sys.h b/rpp/include/sys/sys.h
index f6edc0e7e987a312f9e194cd5a020bca3a3b978a..055b0138b9527668670c1c3fc2ad126409213335 100644 (file)
--- a/rpp/include/sys/sys.h
+++ b/rpp/include/sys/sys.h
@@ -13,6 +13,13 @@
 
 #include "base.h"
 
+typedef enum Loopbacktype {
+
+    Digital = 0,
+    Analog = 1
+
+} Loopbacktype_t;
+
 #include "sys/cpu_def.h"
 #include "sys/hw_emac_ctrl.h"
 #include "sys/hw_emac.h"

diff --git a/rpp/include/types.h b/rpp/include/types.h
index 3773b6ac7abddeb2df0d288ee5d21ea36e53b331..41eefeac82bce685aebdca303fb2bc0fcca17a94 100644 (file)
--- a/rpp/include/types.h
+++ b/rpp/include/types.h
@@ -11,117 +11,100 @@
 #ifndef __RPP_TYPES_H
 #define __RPP_TYPES_H
 
-/** @def NULL
-*   @brief NULL definition
-*/
-#ifndef NULL
+/**
+ * NULL definition
+ */
 #define NULL ((void *) 0x0)
-#endif
-
-/** @def TRUE
-*   @brief definition for TRUE
-*/
-#ifndef TRUE
-#define TRUE 0x1
-#endif
-
-/** @def FALSE
-*   @brief Boolean definition for FALSE
-*/
-#ifndef FALSE
-#define FALSE 0x0
-#endif
-
-/** @def HIGH
-*   @brief Logic definition for logic HIGH
-*/
-#ifndef HIGH
+
+
+/**
+ * Boolean definition for TRUE
+ */
+#define TRUE 1
+
+
+/**
+ * Boolean definition for FALSE
+ */
+#define FALSE 0
+
+
+/**
+ * Logic definition for logic HIGH
+ */
 #define HIGH TRUE
-#endif
 
-/** @def LOW
-*   @brief Logic definition for logic LOW
-*/
-#ifndef LOW
+
+/**
+ * Logic definition for logic LOW
+ */
 #define LOW FALSE
-#endif
-
-/** @def SUCCESS
-*   @brief definition for SUCCESS
-*/
-#ifndef SUCCESS
-#define SUCCESS  0
-#endif
-
-/** @def FAILURE
-*   @brief definition for FAILURE
-*/
-#ifndef FAILURE
+
+
+/**
+ * Definition for SUCCESS
+ */
+#define SUCCESS 0
+
+
+/**
+ * Definition for FAILURE
+ */
 #define FAILURE -1
-#endif
 
 
-#ifndef _UINT64_T_DECLARED
+/**
+ * Unsigned 64 bits integer datatype definition.
+ */
 typedef unsigned long long uint64_t;
-#define _UINT64_T_DECLARED
-#endif
 
-#ifndef _UINT32_T_DECLARED
+
+/**
+ * Unsigned 32 bits integer datatype definition.
+ */
 typedef unsigned int uint32_t;
-#define _UINT32_T_DECLARED
-#endif
 
-#ifndef _UINT16_T_DECLARED
+
+/**
+ * Unsigned 16 bits integer datatype definition.
+ */
 typedef unsigned short uint16_t;
-#define _UINT16_T_DECLARED
-#endif
 
-#ifndef _UINT8_T_DECLARED
+
+/**
+ * Unsigned 8 bits integer datatype definition.
+ */
 typedef unsigned char uint8_t;
-#define _UINT8_T_DECLARED
-#endif
 
-#ifndef _INT64_T_DECLARED
+
+/**
+ * Signed 64 bits integer datatype definition.
+ */
 typedef signed long long int64_t;
-#define _INT64_T_DECLARED
-#endif
 
-#ifndef _INT32_T_DECLARED
-typedef signed int int32_t;
-#define _INT32_T_DECLARED
-#endif
 
-#ifndef _INT16_T_DECLARED
-typedef signed short int16_t;
-#define _INT16_T_DECLARED
-#endif
+/**
+ * Signed 32 bits integer datatype definition.
+ */
+typedef signed int int32_t;
 
-#ifndef _INT8_T_DECLARED
-typedef signed char int8_t;
-#define _INT8_T_DECLARED
-#endif
 
-#ifndef _BOOLEAN_T_DECLARED
-typedef unsigned char boolean_t;
-#define _BOOLEAN_T_DECLARED
-#endif
+/**
+ * Signed 16 bits integer datatype definition.
+ */
+typedef signed short int16_t;
 
 
-/** @enum Loopbacktype
-*   @brief Loopback type definition
-*/
-/** @typedef Loopbacktype_t
-*   @brief Loopback type Type Definition
-*
-*   This type is used to select the module Loopback type Digital or Analog
-*   loopback.
-*/
-typedef enum Loopbacktype {
+/**
+ * Signed 8 bits integer datatype definition.
+ */
+typedef signed char int8_t;
 
-    Digital = 0,
-    Analog = 1
 
-} Loopbacktype_t;
+/**
+ * Boolean datatype definition.
+ */
+typedef unsigned char boolean_t;
 
 
 #endif /* __RPP_TYPES_H */