add some c++ doc

This commit is contained in:
Lukas Heiligenbrunner 2020-08-02 16:56:49 +00:00
parent 0261f186bd
commit b065007b19

View File

@ -12,14 +12,39 @@ class WifiManager {
public: public:
WifiManager(); WifiManager();
/**
* initialize the webserver
*/
void init(); void init();
/**
* handles new web requests and holds the webserver alive
* call as often as possible
*/
void holdAlive(); void holdAlive();
/**
* reads the max-wait-time out of eeprom
* @return max-wait-time in seconds
*/
int getWaitTime(); int getWaitTime();
/**
* sets the last time when the pump was on
* @param lastPumpTime pump time in ms
*/
void setlastPumpTime(unsigned long lastPumpTime); 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); void setlastWaterOutage(unsigned long lastWaterOutage);
/**
* sets the duration of the last pump cycle
* @param lastPumpDuration duration in ms
*/
void setPumpDuration(unsigned long lastPumpDuration); void setPumpDuration(unsigned long lastPumpDuration);
private: private: