From 89befdb9b259d02249876e39ec6fd28860272439 Mon Sep 17 00:00:00 2001 From: Thales Lima Oliveira Date: Fri, 6 Oct 2017 17:06:15 -0300 Subject: A lot of documentation written --- Project/Exponential.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'Project/Exponential.h') diff --git a/Project/Exponential.h b/Project/Exponential.h index e9fd019..accdd48 100644 --- a/Project/Exponential.h +++ b/Project/Exponential.h @@ -27,7 +27,6 @@ class ExponentialForm; * @author Thales Lima Oliveira * @date 05/10/2017 * @brief Generates an output following an exponential function. - * \f$ output = A\cdot e^{B\cdot input} \f$ * @file Exponential.h */ class Exponential : public ControlElement @@ -46,7 +45,15 @@ class Exponential : public ControlElement virtual void GetValues(double& aValue, double& bValue); virtual void SetValues(double aValue, double bValue); - + + /** + * @brief Calculates the exponential. + * + *
\f$ output = A\cdot e^{B\cdot input} \f$
+ * @param input Input value. + * @param timeStep Time step. + * @return Aways true. + */ virtual bool Solve(double input, double timeStep); virtual Element* GetCopy(); -- cgit