From dccd6f27739a7b93f822046c05f51e8beead2cd8 Mon Sep 17 00:00:00 2001
From: Simon <info@simonwil.de>
Date: Sat, 17 Sep 2022 15:50:00 +0200
Subject: [PATCH] Rename some functions, improve documentation

---
 app/doc/Class.plantuml     | 9 ++++++++-
 app/include/fan/Fan.h      | 4 ++--
 app/include/fan/HwmonFan.h | 4 ++--
 3 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/app/doc/Class.plantuml b/app/doc/Class.plantuml
index 962531c..3764179 100644
--- a/app/doc/Class.plantuml
+++ b/app/doc/Class.plantuml
@@ -9,8 +9,15 @@ interface Sensor {
         {abstract} string name()
 }
 
-class HwmonFan {
+class PwmControl {
+        +void pwm(int percent)
+        +int pwm()
 
+        + void enableManualControl()
+        + void reset()
+
+        - System Paths
+        - Initial Values
 }
 
 Fan <|-- HwmonFan
diff --git a/app/include/fan/Fan.h b/app/include/fan/Fan.h
index 71d3e8a..9da52f2 100644
--- a/app/include/fan/Fan.h
+++ b/app/include/fan/Fan.h
@@ -3,8 +3,8 @@
 
 class Fan {
 public:
-  virtual void PWM(int percent) = 0;
-  virtual int RPM() = 0;
+  virtual void pwm(int percent) = 0;
+  virtual int rpm() = 0;
 };
 
 #endif // FAN_H_
diff --git a/app/include/fan/HwmonFan.h b/app/include/fan/HwmonFan.h
index 7601940..4be401c 100644
--- a/app/include/fan/HwmonFan.h
+++ b/app/include/fan/HwmonFan.h
@@ -12,8 +12,8 @@ public:
   HwmonFan(std::unique_ptr<PwmControl> pwmControl,
            std::unique_ptr<Sensor> rpmSensor);
 
-  void PWM(int percent) override;
-  int RPM() override;
+  void pwm(int percent) override;
+  int rpm() override;
 
 private:
   std::unique_ptr<PwmControl> mPwmControl;