Continued working on the create and added doxygen files

doxygen/tabs.css

@@ -0,0 +1,128 @@
+/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */
+
+div.navigation {
+	display:block;
+	float:left;
+	clear:both;
+	width:100%;
+	padding-top:10px;
+	padding-bottom:30px;
+	border-bottom:1px dotted #E0E0E0;
+	height: 60px;
+	background:url(background_navigation.png);
+}
+
+div.contents {
+	float:left;
+	clear:both;
+
+}
+
+address {
+	display:none;
+}
+
+DIV.tabs
+{
+   float            : left;
+   width            : 100%;
+   margin-bottom    : 4px;
+}
+
+DIV.tabs UL
+{
+   margin           : 0px;
+   padding-left     : 0px;
+   list-style       : none;
+}
+
+DIV.tabs LI, DIV.tabs FORM
+{
+   display          : inline;
+   margin           : 0px;
+   padding          : 0px;
+	background-color:#FFFFFF;
+}
+
+DIV.tabs FORM
+{
+   float            : right;
+}
+
+DIV.tabs A
+{
+   float            : left;
+   font-size        : 80%;
+   font-weight      : bold;
+   text-decoration  : none;
+}
+
+DIV.tabs A:hover
+{
+   background-position: 100% -150px;
+}
+
+DIV.tabs A:link, DIV.tabs A:visited,
+DIV.tabs A:active, DIV.tabs A:hover
+{
+       color: #1A419D;
+}
+
+DIV.tabs SPAN
+{
+   float            : left;
+   display          : block;
+   padding          : 5px 9px;
+   white-space      : nowrap;
+	border-top:1px dotted #E0E0E0;
+	border-bottom:1px dotted #E0E0E0;
+}
+
+DIV.tabs #MSearchBox
+{
+   float            : right;
+   display          : inline;
+   font-size        : 1em;
+}
+
+DIV.tabs TD
+{
+   font-size        : 80%;
+   font-weight      : bold;
+   text-decoration  : none;
+}
+
+
+
+/* Commented Backslash Hack hides rule from IE5-Mac \*/
+DIV.tabs SPAN {float : none;}
+/* End IE5-Mac hack */
+
+DIV.tabs A:hover SPAN
+{
+   background-position: 0% -150px;
+}
+
+DIV.tabs LI.current A
+{
+   background-position: 100% -150px;
+   border-width     : 0px;
+	background-color:	#F0F0F0;
+	background: #F0F0F0 url(img_downArrow.png) center bottom no-repeat;
+}
+
+DIV.tabs LI.current SPAN
+{
+   background-position: 0% -150px;
+   padding-bottom   : 6px;
+}
+
+DIV.navpath
+{
+   background       : none;
+   border           : none;
+   border-bottom    : 1px solid #84B0C7;
+   text-align       : center;
+   margin           : 2px;
+   padding          : 2px;
+}

include/analog.hpp

@@ -1,8 +1,21 @@
+/*!
+ * \file analog.hpp
+ * \brief Classes for working with analog sensors
+ * \author Braden McDorman
+ * \copyright KISS Insitute for Practical Robotics
+ */
+
 #ifndef _ANALOG_HPP_
 #define _ANALOG_HPP_
 
 #include "sensor.hpp"
 
+/*!
+ * \class Analog
+ * \brief Implements the sensor type "analog"
+ * \details Returns 10 bit unsigned integers
+ * \see Analog8
+ */
 class Analog : public Sensor<unsigned short>
 {
 public:
@@ -13,12 +26,22 @@ class Analog : public Sensor<unsigned short>
 	virtual void setPullup(bool pullup);
 	virtual bool pullup() const;
 
+	/*!
+	 * Gets the physical port associated with this analog instance
+	 * \return physical port address
+	 */
 	unsigned char port() const;
 
 private:
 	unsigned char m_port;
 };
 
+/*!
+ * \class Analog8
+ * \brief A derivative of the Analog class that returns 8 bit values rather than 10 bit ones.
+ * \details Returns 8 bit unsigned integers
+ * \see Analog
+ */
 class Analog8 : public Analog
 {
 public:

include/battery.h

@@ -1,10 +1,21 @@
+/*!
+ * \file battery.h
+ * \brief Methods for determining the device's power level
+ * \author Braden McDorman
+ * \copyright KISS Insitute for Practical Robotics
+ */
+
 #ifndef _BATTERY_H_
 #define _BATTERY_H_
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/*!
+ * The device's power level
+ * \return The device's current voltage
+ */
 float power_level();
 
 #ifdef __cplusplus

include/battery.hpp

@@ -1,6 +1,17 @@
+/*!
+ * \file battery.hpp
+ * \brief Classes for determining the device's power level
+ * \author Braden McDorman
+ * \copyright KISS Insitute for Practical Robotics
+ */
+
 #ifndef _BATTERY_HPP_
 #define _BATTERY_HPP_
 
+/*!
+ * \class Battery
+ * \brief Provides helper methods for accessing the device's power level
+ */
 class Battery
 {
 public:

include/button.h

@@ -1,37 +1,174 @@
+/*!
+ * \file button.h
+ * \brief Methods for manipulating and using software buttons
+ * \author Braden McDorman
+ * \copyright KISS Insitute for Practical Robotics
+ */
+
 #ifndef _BUTTON_H_
 #define _BUTTON_H_
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-void a_button_set_text(const char *text);
-void b_button_set_text(const char *text);
-void c_button_set_text(const char *text);
-void x_button_set_text(const char *text);
-void y_button_set_text(const char *text);
-void z_button_set_text(const char *text);
+/*!
+ * Updates the A button's text.
+ * \param text The text to display. Limit of 16 characters.
+ */
+void set_a_button_text(const char *text);
+
+/*!
+ * Updates the B button's text.
+ * \param text The text to display. Limit of 16 characters.
+ */
+void set_b_button_text(const char *text);
+
+/*!
+ * Updates the C button's text.
+ * \param text The text to display. Limit of 16 characters.
+ */
+void set_c_button_text(const char *text);
+
+/*!
+ * Updates the X button's text.
+ * \param text The text to display. Limit of 16 characters.
+ */
+void set_x_button_text(const char *text);
+
+/*!
+ * Updates the Y button's text.
+ * \param text The text to display. Limit of 16 characters.
+ */
+void set_y_button_text(const char *text);
 
+/*!
+ * Updates the Z button's text.
+ * \param text The text to display. Limit of 16 characters.
+ */
+void set_z_button_text(const char *text);
+
+/*!
+ * Gets the A button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \note This function will block until the button is no longer pressed.
+ * \see a_button_pressed
+ */
 int a_button();
+
+/*!
+ * Gets the B button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \note This function will block until the button is no longer pressed.
+ * \see b_button_pressed
+ */
 int b_button();
+
+/*!
+ * Gets the C button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \note This function will block until the button is no longer pressed.
+ * \see c_button_pressed
+ */
 int c_button();
+
+/*!
+ * Gets the X button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \note This function will block until the button is no longer pressed.
+ * \attention This button is an extra button. Use set_extra_buttons_visible(int) to show this button.
+ * \see x_button_pressed
+ */
 int x_button();
+
+/*!
+ * Gets the Y button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \note This function will block until the button is no longer pressed.
+ * \attention This button is an extra button. Use set_extra_buttons_visible(int) to show this button.
+ * \see y_button_pressed
+ */
 int y_button();
+
+/*!
+ * Gets the Z button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \note This function will block until the button is no longer pressed.
+ * \attention This button is an extra button. Use set_extra_buttons_visible(int) to show this button.
+ * \see z_button_pressed
+ */
 int z_button();
 
+/*!
+ * Gets the A button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \see a_button
+ */
 int a_button_pressed();
+
+/*!
+ * Gets the B button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \see b_button
+ */
 int b_button_pressed();
+
+/*!
+ * Gets the C button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \see c_button
+ */
 int c_button_pressed();
+
+/*!
+ * Gets the X button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \attention This button is an extra button. Use set_extra_buttons_visible(int) to show this button.
+ * \see x_button
+ */
 int x_button_pressed();
+
+/*!
+ * Gets the Y button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \attention This button is an extra button. Use set_extra_buttons_visible(int) to show this button.
+ * \see y_button
+ */
 int y_button_pressed();
+
+/*!
+ * Gets the Z button's state (pressed or not pressed.)
+ * \return 1 for pressed, 0 for not pressed
+ * \attention This button is an extra button. Use set_extra_buttons_visible(int) to show this button.
+ * \see z_button
+ */
 int z_button_pressed();
 
 int any_button();
 
+/*!
+ * Shows the X, Y, and Z buttons.
+ * \see set_extra_buttons_visible
+ */
 void extra_buttons_show();
+
+/*!
+ * Hides the X, Y, and Z buttons. This is the default.
+ * \see set_extra_buttons_visible
+ */
 void extra_buttons_hide();
-int extra_buttons_get_visible();
-void extra_buttons_set_visible(int visible);
+
+/*!
+ * Determines whether or not the X, Y, and Z buttons are visible.
+ * \see set_extra_buttons_visible
+ */
+int get_extra_buttons_visible();
+
+/*!
+ * Sets whether or not the X, Y, and Z buttons are visible.
+ * \see get_extra_buttons_visible
+ */
+void set_extra_buttons_visible(int visible);
 
 #ifdef __cplusplus
 }