Revision 18e2028b
ID | 18e2028bdd878470a70059c3db813b40d143cf52 |
Child | ad0e9d48 |
Updated motors.cpp and motors.h to comply with coding standards and doxygen.
Changed the module comments so motors are properly labeled as a the motor module.
Chaned indentation to four spaces.
Put braces on a new line.
scout/motors/src/motors.h | ||
---|---|---|
1 | 1 |
/** |
2 |
*Copyright (c) 2007 Colony Project |
|
2 |
* Copyright (c) 2007 Colony Project
|
|
3 | 3 |
* |
4 | 4 |
* Permission is hereby granted, free of charge, to any person |
5 | 5 |
* obtaining a copy of this software and associated documentation |
... | ... | |
23 | 23 |
* OTHER DEALINGS IN THE SOFTWARE. |
24 | 24 |
**/ |
25 | 25 |
|
26 |
|
|
27 | 26 |
/** |
28 | 27 |
* @file motors.h |
29 |
* @brief Contains motor declarations and functions |
|
28 |
* @brief Contains motor declarations and functions.
|
|
30 | 29 |
* |
31 | 30 |
* Contains functions and definitions for the use of |
32 |
* motors |
|
31 |
* motors.
|
|
33 | 32 |
* |
34 | 33 |
* @author Colony Project, CMU Robotics Club |
34 |
* @author Benjamin Wasserman |
|
35 | 35 |
**/ |
36 | 36 |
|
37 |
/* Author: Ben Wasserman |
|
38 |
*/ |
|
39 |
|
|
40 | 37 |
#ifndef _MOTORS_H_ |
41 | 38 |
#define _MOTORS_H_ |
42 | 39 |
|
43 | 40 |
#include "motors/query_motors.h" |
44 | 41 |
#include "motors/set_motors.h" |
45 | 42 |
|
46 |
|
|
47 |
/** @brief Initialize the motors module and driver **/ |
|
43 |
/** @brief Initialize the motors module and driver. **/ |
|
48 | 44 |
int main(int argc, char **argv); |
49 |
/** @brief Responds to topic to set motor speeds and configs **/ |
|
45 |
|
|
46 |
/** @brief Responds to topic to set motor speeds and configs. **/ |
|
50 | 47 |
void motors_set(const motors::set_motors::ConstPtr& msg); |
51 |
/** @brief Responds to service to query motor speeds **/ |
|
48 |
|
|
49 |
/** @brief Responds to service to query motor speeds. **/ |
|
52 | 50 |
bool motors_query(motors::query_motors::Request &req, |
53 |
motors::query_motors::Response &res); |
|
51 |
motors::query_motors::Response &res);
|
|
54 | 52 |
|
55 | 53 |
#endif |
Also available in: Unified diff