From b065007b19706c79f5b357ce720db6a9c070c319 Mon Sep 17 00:00:00 2001 From: Lukas Heiligenbrunner Date: Sun, 2 Aug 2020 16:56:49 +0000 Subject: [PATCH] add some c++ doc --- src/WifiManager.h | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/src/WifiManager.h b/src/WifiManager.h index b9834c0..89bedec 100644 --- a/src/WifiManager.h +++ b/src/WifiManager.h @@ -12,14 +12,39 @@ class WifiManager { public: WifiManager(); + /** + * initialize the webserver + */ void init(); + /** + * handles new web requests and holds the webserver alive + * call as often as possible + */ void holdAlive(); + /** + * reads the max-wait-time out of eeprom + * @return max-wait-time in seconds + */ int getWaitTime(); + /** + * sets the last time when the pump was on + * @param lastPumpTime pump time in ms + */ void setlastPumpTime(unsigned long lastPumpTime); + + /** + * sets the last time of a water outage + * @param lastWaterOutage last wateroutage time in ms + */ void setlastWaterOutage(unsigned long lastWaterOutage); + + /** + * sets the duration of the last pump cycle + * @param lastPumpDuration duration in ms + */ void setPumpDuration(unsigned long lastPumpDuration); private: