From bc5a3e8923cb8efedbbd5b88e212eb0e9009cf87 Mon Sep 17 00:00:00 2001
From: Thales Lima Oliveira <thaleslima.ufu@gmail.com>
Date: Thu, 5 Oct 2017 20:02:59 -0300
Subject: Add copyright on files and documentation update

---
 Project/Gain.h | 33 +++++++++++++++++++++++++++++----
 1 file changed, 29 insertions(+), 4 deletions(-)

(limited to 'Project/Gain.h')

diff --git a/Project/Gain.h b/Project/Gain.h
index 82b2793..6b378d2 100644
--- a/Project/Gain.h
+++ b/Project/Gain.h
@@ -1,3 +1,20 @@
+/*
+ *  Copyright (C) 2017  Thales Lima Oliveira <thales@ufu.br>
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
 #ifndef GAIN_H
 #define GAIN_H
 
@@ -8,6 +25,14 @@
 
 class GainForm;
 
+/**
+ * @class Gain
+ * @author Thales Lima Oliveira <thales@ufu.br>
+ * @date 05/10/2017
+ * @brief Provide an output multiplying the input by a constant.
+ * \f$ output = K \cdot input \f$
+ * @file Gain.h
+ */
 class Gain : public ControlElement
 {
    public:
@@ -24,17 +49,17 @@ class Gain : public ControlElement
     virtual void SetValue(double value);
     virtual double GetValue() const { return m_value; }
     virtual void UpdatePoints();
-    
+
     virtual bool Solve(double input, double timeStep);
-    
+
     virtual Element* GetCopy();
 
    protected:
     double m_value = 1.0;
-    
+
     wxGLString* m_glStringValue = NULL;
     int m_fontSize = 10;
-    
+
     std::vector<wxPoint2DDouble> m_triPts;
 };
 
-- 
cgit 


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/Gain.h | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'Project/Gain.h')

diff --git a/Project/Gain.h b/Project/Gain.h
index 6b378d2..7245e2f 100644
--- a/Project/Gain.h
+++ b/Project/Gain.h
@@ -30,7 +30,6 @@ class GainForm;
  * @author Thales Lima Oliveira <thales@ufu.br>
  * @date 05/10/2017
  * @brief Provide an output multiplying the input by a constant.
- * \f$ output = K \cdot input \f$
  * @file Gain.h
  */
 class Gain : public ControlElement
@@ -49,7 +48,14 @@ class Gain : public ControlElement
     virtual void SetValue(double value);
     virtual double GetValue() const { return m_value; }
     virtual void UpdatePoints();
-
+    /**
+     * @brief Multiply the input by a constant
+     * 
+     * <center>\f$ output = K \cdot input \f$</center>
+     * @param input Input value.
+     * @param timeStep Time step.
+     * @return Always true.
+     */
     virtual bool Solve(double input, double timeStep);
 
     virtual Element* GetCopy();
-- 
cgit