Revision 126fea96

View differences:

scout/Doxyfile
35 35

  
36 36
# Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
37 37

  
38
PROJECT_BRIEF          = "The Colony Scout swarm robotics platform"
38
PROJECT_BRIEF          = "The Colony Scout Operating System"
39 39

  
40 40
# With the PROJECT_LOGO tag one can specify an logo or icon that is
41 41
# included in the documentation. The maximum height of the logo should not
scout/buttons/src/buttons.cpp
27 27
 * @file buttons.cpp
28 28
 * @brief Contains code to control the buttons.
29 29
 *
30
 * Implementation of functions for button use.
31
 *
32 30
 * @author Colony Project, CMU Robotics Club
33 31
 * @author Priyanka Deo
34 32
 * @author Alex Zirbel
35
 **/
36

  
37
#include "ros/ros.h"
38
#include "buttons.h"
39
#include <cstdlib>
40

  
41
/**
33
 *
42 34
 * @defgroup buttons Buttons
43 35
 * @brief Functions for using the buttons
44 36
 *
45 37
 * @{
46 38
 **/
47 39

  
40
#include "ros/ros.h"
41
#include "buttons.h"
42
#include <cstdlib>
43

  
48 44
/* Button state variables
49 45
 */
50 46
static int button1_pressed; /**< Whether or not button 1 is pressed. */
scout/buttons/src/buttons.h
43 43
#define QUEUE_SIZE 10
44 44
#define BUTTON_PRESSED 0x1
45 45

  
46
/** @brief Initialize the buttons module and driver. **/
47 46
int main(int argc, char **argv);
48 47

  
49 48
#endif
scout/encoders/src/encoders.cpp
32 32
 * @author Colony Project, CMU Robotics Club
33 33
 * @author Alex Zirbel
34 34
 * @author Tom Mullins
35
 **/
36 35

  
37
#include <ros/ros.h>
38
#include "encoders.h"
39

  
40
/**
41 36
 * @defgroup encoders Encoders
42 37
 * @brief Functions for using the encoders
43 38
 *
44 39
 * @{
45
 */
40
 **/
41

  
42
#include <ros/ros.h>
43
#include "encoders.h"
46 44

  
47 45
/* Encoder instances */
48 46
/* @todo make sure these are the correct numbers */
scout/encoders/src/encoders.h
48 48
        std::fstream fticks; /**< The file in sysfs containing tick count */
49 49
};
50 50

  
51
/** @brief Initialize the encoders module and driver **/
52 51
int main(int argc, char **argv);
53 52

  
54
/** @brief Responds to service to query encoder data **/
55 53
bool handle_encoders_query(messages::query_encoders::Request  &req,
56 54
                           messages::query_encoders::Response &res);
57 55

  
scout/libscout/src/CliffsensorControl.cpp
39 39
#include <cstdlib>
40 40

  
41 41
/**
42
 * @defgroup cliffsensor Cliffsensor
43
 * @brief Functions for using the cliffsensors
44
 *
45
 * @{
46
 **/
47

  
48
/**
49 42
 * @brief Initializes the Cliffsensor module in libscout.
50 43
 *
51 44
 * This is the main function for the cliffsensors node. It is run when the node
......
114 107
{
115 108
    return (front_raw || left_raw || right_raw);
116 109
}
117

  
118
/** @} **/
scout/motors/src/motors.cpp
32 32
 * @author Colony Project, CMU Robotics Club
33 33
 * @author Ben Wasserman
34 34
 * @author Tom Mullins
35

  
36
 * @defgroup motors Motors
37
 * @brief Functions for using the motors
38
 *
39
 * @{
35 40
 */
36 41

  
37 42
#include <ros/ros.h>
......
41 46
using namespace std;
42 47

  
43 48
/**
44
 * @defgroup motors Motors
45
 * @brief Functions for using the motors
46
 *
47
 * @{
48
 */
49

  
50
/**
51 49
 * @brief Motor constructor
52 50
 *
53 51
 * Opens device file and reads initial PWM value
scout/motors/src/motors.h
45 45

  
46 46
#define QUEUE_SIZE 10
47 47

  
48
/** @brief Initialize the motors module and driver. **/
49 48
int main(int argc, char **argv);
50 49

  
51
/** @brief Responds to topic to set motor speeds and configs. **/
52 50
void motors_set(const messages::set_motors::ConstPtr& msg);
53 51

  
54
/** @brief Responds to service to query motor speeds. **/
55 52
bool motors_query(messages::query_motors::Request &req,
56 53
                  messages::query_motors::Response &res);
57 54

  
scout/power/src/power.cpp
31 31
 *
32 32
 * @author Colony Project, CMU Robotics Club
33 33
 * @author Jeff Cooper
34
 **/
35

  
36
#include "ros/ros.h"
37
#include "power.h"
38
#include <cstdlib>
39 34

  
40
/**
41 35
 * @defgroup power Power
42 36
 * @brief Functions for monitoring and regulating the power systems
43 37
 *
44 38
 * @{
45 39
 **/
46 40

  
41
#include "ros/ros.h"
42
#include "power.h"
43
#include <cstdlib>
44

  
47 45
/* Power system state variables
48 46
 * updated by the AVR, used to respond to
49 47
 * power queries and send messages
50 48
 *
51 49
 */
50

  
52 51
/** @todo Fix types: static */
53 52

  
54 53
/** @TODO figure out if we can get things like the current draw from the AVR. */
scout/power/src/power.h
39 39

  
40 40
#include <messages/query_power.h>
41 41

  
42
/** @brief Initialize the power module and driver. **/
43 42
int main(int argc, char **argv);
44 43

  
45
/** @brief Responds to service to query power informatio **/
46 44
bool power_query(messages::query_power::Request &req,
47 45
                 messages::query_power::Response &res);
48 46

  
49
/** @breif Function that sends the power_state_changed message **/
50 47
void send_power_state_changed();
51 48
#endif

Also available in: Unified diff