Skip to content

Commit 69c747a

Browse files
committed
Added Comments
1 parent c6f01d4 commit 69c747a

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

lib/ZumoOta/src/App.h

+5-5
Original file line numberDiff line numberDiff line change
@@ -97,29 +97,29 @@ class App
9797

9898
private:
9999
/**
100-
* Flag: Webserver is initialized
100+
* Flag: Webserver is initialized.
101101
*/
102102
bool m_isWebServerInitialized;
103103

104104
/**
105-
* Instance of the FileManager class
105+
* Instance of the FileManager class.
106106
*responsible for managing the LittleFs file System.
107107
*/
108108
FileManager m_fileManager;
109109

110110
/**
111-
* Instance of the WebServerCustom class
111+
* Instance of the WebServerCustom class.
112112
*representing a custom webserver for the application.
113113
*/
114114
WebServerCustom m_webServer;
115115

116116
/**
117-
* Instance of the Upload class
117+
* Instance of the Upload class.
118118
*/
119119
Upload m_upload;
120120

121121
/**
122-
* Instance of the BootloaderCom class
122+
* Instance of the BootloaderCom class.
123123
*/
124124
BootloaderCom m_bootloader;
125125
};

lib/ZumoOta/src/BootloaderCom.h

+13-2
Original file line numberDiff line numberDiff line change
@@ -92,20 +92,31 @@ class BootloaderCom
9292
bool compareExpectedAndReceivedResponse(const uint8_t command[], size_t commandSize, const uint8_t expectedResponse[], size_t expectedResponseSize);
9393

9494
private:
95+
/**
96+
*@brief Enumeration representing different states for the BootloaderCom class.
97+
*/
9598
enum State
9699
{
97100
Idle,
98101
Pending,
99102
ReadingResponse,
100103
Complete
101104
};
105+
106+
/**
107+
*@brief Current state of the BootloaderCom class.
108+
*Initialized to Idle by default.
109+
*/
102110
State m_state;
103111

104-
FlashManager myFlashManager;
112+
/**
113+
* Instance of the BootloaderCom class
114+
*/
115+
FlashManager myFlashManager;
105116

106117
/*
107118
* Flag indicating whether the FlashManager is currently waiting for a response.
108-
*/
119+
*/
109120
bool m_waitingForResponse;
110121

111122
};

lib/ZumoOta/src/FlashManager.h

+1-8
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,10 @@
3030
class FlashManager
3131
{
3232
private:
33-
34-
/**
35-
*Buffer to store received data.
36-
*/
37-
uint8_t buffer[256];
38-
3933
/**
4034
*Number of bytes read from the stream;
4135
*/
42-
size_t m_bytesRead;
43-
36+
size_t m_bytesRead;
4437

4538

4639
public:

0 commit comments

Comments
 (0)