comparison include/Utilities.h @ 95:c529505203ee

Updated doxygen for Utilities.h

 #ifndef UTILITIES_H_
 #define UTILITIES_H_
 
 #include "BeagleRT.h"
 
+/**
+ * \defgroup iofunctions I/O functions and constants
+ *
+ * These functions and macros are used for audio, analog and digital I/O. All the
+ * I/O functions require the BeagleRTContext data structure from render() to be passed
+ * in. This means that these functions are, by design, \b only usable from within
+ * the rendering thread.
+ * 
+ * The naming conventions are loosely derived from the Arduino environment, and the
+ * syntax is similar. Unlike Arduino, the I/O functions require the frame number at which
+ * the read or write should take place, since all I/O happens synchronously with the
+ * audio clock.
+ *
+ * @{
+ */
+
 #define HIGH 0x1
 #define LOW  0x0
 
 #define INPUT 0x0
 #define OUTPUT 0x1
 
+/** @} */
+
+/**
+ * \ingroup wiring
+ *
+ * @{
+ */
+
 /// Set the given bit in \c word to 1.
 #define setBit(word,bit) 			((word) | (1 << (bit)))
 
 /// Clear the given bit in \c word to 0.
 #define clearBit(word,bit) 			((word) &~ (1 << (bit)))

 /// Check if the given bit in \c word is 1 (returns nonzero) or 0 (returns zero).
 #define getBit(word,bit) 			(((word) >> (bit)) & 1)
 
 /// Set/clear the given bit in \c word to \c value.
 #define changeBit(word,bit,value) 	((clearBit((word),(bit))) | ((value) << (bit)))
+
+/** @} */
+
+/**
+ * \ingroup iofunctions
+ *
+ * @{
+ */
 
 #if 1
 // Note: pinMode(), analogWrite() and digitalWrite() should be able to be called from setup()
 // Likewise, thread launch should be able to be called from setup()
 // Also, make volume change functions callable from render() thread -- as an aux task?

  * BeagleBone Black are available. See the constants P8_xx and P9_xx defined in
  * digital_gpio_mapping.h.
  * \param value Direction of the pin (\c INPUT or \c OUTPUT).
  */
 void pinModeFrameOnce(BeagleRTContext *context, int frame, int channel, int mode);
+
+/** @} */
 
 #else
 
 // Macros for accessing the analog values: usable _only_ within render()
 

 #define digitalRead(pin, frame) ( getBit(digital[(frame)], pin+16) )
 
 #endif
 
 /**
+ * \defgroup wiring Wiring language support
+ *
+ * These are functions found in the Wiring (Arduino) language which are not directly
+ * related to I/O but are provided as a convenience.
+ *
+ * @{
+ */
+
+/**
  * \brief Linearly rescale a number from one range of values to another.
  *
  * This function linearly scales values of \c x such that the range in_min to
  * in_max at the input corresponds to the range out_min to out_max
  * at the output. Values outside this range are extrapolated.

  * \param max_val Maximum possible value.
  * \return Constrained value.
  */
 float constrain(float x, float min_val, float max_val);
 
+/** @} */
+
 #endif /* UTILITIES_H_ */