From 89befdb9b259d02249876e39ec6fd28860272439 Mon Sep 17 00:00:00 2001
From: Thales Lima Oliveira <thaleslima.ufu@gmail.com>
Date: Fri, 6 Oct 2017 17:06:15 -0300
Subject: A lot of documentation written

---
 Project/RateLimiter.h | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

(limited to 'Project/RateLimiter.h')

diff --git a/Project/RateLimiter.h b/Project/RateLimiter.h
index bab52db..3d57498 100644
--- a/Project/RateLimiter.h
+++ b/Project/RateLimiter.h
@@ -49,16 +49,17 @@ class RateLimiter : public ControlElement
     void SetLowLimit(double lowLimit) { m_lowLimit = lowLimit; }
     /**
      * @brief Calculate the rate and limits it if exceeds.<br>
-     * The rate is calculated by:<br><br>
-     * \f$ rate = \frac{x(i) - y(i-1)}{\Delta t} \f$<br><br>
-     * \f$ x(i) \f$ is the current input and \f$ y(i-1) \f$ is the previous output.<br>
-     * If the \f$rate\f$ is greater than rising rate (\f$ R \f$), the output will be:<br><br>
-     * \f$ output = \Delta t \cdot R + y(i-1)\f$<br><br>
+     *
+     * The rate is calculated by:
+     * <center>\f$ rate = \frac{x(i) - y(i-1)}{\Delta t} \f$</center>
+     * Where, \f$ x(i) \f$ is the current input and \f$ y(i-1) \f$ is the previous output.<br><br>
+     * If the \f$rate\f$ is greater than rising rate (\f$ R \f$), the output will be:<br>
+     * <center>\f$ output = \Delta t \cdot R + y(i-1)\f$</center>
      * If the \f$rate\f$ is lower than falling rate (\f$ F \f$), the output will be:<br><br>
-     * \f$ output = \Delta t \cdot L + y(i-1) \f$<br><br>
-     * Otherwise:<br><br>
-     * \f$ output = input \f$.
-     * @param input input value.
+     * <center>\f$ output = \Delta t \cdot F + y(i-1) \f$</center>
+     * Otherwise:
+     * <center>\f$ output = input \f$</center>.
+     * @param input Input value.
      * @param timeStep Time step.
      * @return Always true.
      */
-- 
cgit