alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-01 01:11:10 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

upm-c: added doxygen tags to generate documentation for C APIs

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2016-09-26 17:28:21 -07:00
parent 73719a6659
commit eb7a3ceac7
43 changed files with 265 additions and 356 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
src/servo/es08a.h
View File

@ -33,34 +33,19 @@
#include "upm.h"
#include "mraa/pwm.h"
/**
* @library servo
* @sensor es08a
* @comname ES08A Servo
* @altname Grove Servo
* @type servos
* @man emax
* @web http://www.seeedstudio.com/wiki/Grove_-_Servo
* @con pwm
* @kit gsk
*
* @brief API for the ES08A Servo
*
* This module defines the ES08A interface for ES08A servos.
* Like other servos, the ES08A servo has a shaft that can be controlled
* by setting the desired angle. There are also routines for setting
* and getting the minimum and maximum pulse width as well as the
* maximum period.
*
* @image html es08a.jpg
* @snippet es08a.c Interesting
*/
#define ES08A_MIN_PULSE_WIDTH 600
#define ES08A_MAX_PULSE_WIDTH 2200
#define ES08A_PERIOD 20000
#define ES08A_MAX_ANGLE 180.0
/**
* @file es08a.h
* @library servo
* @brief C API for the ES08A Servo
*
* @include es08a.c
*/
/**
* device context
*/

31
src/servo/es9257.h
View File

@ -33,34 +33,19 @@
#include "upm.h"
#include "mraa/pwm.h"
/**
* @library servo
* @sensor es9257
* @comname ES9257 Servo
* @altname Grove Servo
* @type servos
* @man emax
* @web http://www.seeedstudio.com/wiki/Grove_-_Servo
* @con pwm
* @kit gsk
*
* @brief API for the ES9257 Servo
*
* This module defines the ES9257 interface for ES9257 servos.
* Like other servos, the ES9257 servo has a shaft that can be controlled
* by setting the desired angle. There are also routines for setting
* and getting the minimum and maximum pulse width as well as the
* maximum period.
*
* @image html es9257.jpg
* @snippet es9257.c Interesting
*/
#define ES9257_MIN_PULSE_WIDTH 600
#define ES9257_MAX_PULSE_WIDTH 2200
#define ES9257_PERIOD 20000
#define ES9257_MAX_ANGLE 180.0
/**
* @file es9257.h
* @library servo
* @brief C API for the ES9257 Servo
*
* @include es9257.c
*/
/*
* device context
*/