Doxygen update

git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@428 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
dvl
2018-01-15 11:40:43 +00:00
parent 15ab232e82
commit cfb55967c7
12 changed files with 111 additions and 1 deletions

View File

@@ -66,6 +66,7 @@ struct Pid
* PID_construct
* Constructor for a PID regulator
*
* @memberof Pid
* @param self PID object to construct
* @param Kp proportional constant
* @param Ki integration constant
@@ -86,6 +87,7 @@ extern ErrorStatus PID_construct(struct Pid* self, int Kp, int Ki, int Kd, int i
* PID_destruct
* Destructor for a PID regulator
*
* @memberof Pid
* @param self PID object to destruct
*
* @return void
@@ -100,6 +102,7 @@ extern void PID_destruct(struct Pid* self);
* PID_reset
* Resets the pid regulator and cleans all history
*
* @memberof Pid
* @param self PID object to reset
*
* @return void
@@ -114,6 +117,7 @@ extern void PID_reset(struct Pid* self);
* PID_calculate
* Calculate
*
* @memberof Pid
* @param self The PID object
* @param input The input
* @param error the error input to calculate