Skip to content

Commit 2b9fc3c

Browse files
committed
Rephrase some comments
1 parent f68d2cc commit 2b9fc3c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/OLEDDisplay.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -160,12 +160,12 @@ class OLEDDisplay : public Stream {
160160
uint16_t width(void) const { return displayWidth; };
161161
uint16_t height(void) const { return displayHeight; };
162162

163-
// Prepare the driver for resuming display usage after a deep sleep.
164-
// Returns true on success. Returns false on failure (no display detected etc).
163+
// Use this to resume after a deep sleep without resetting the display (what init() would do).
164+
// Returns true if connection to the display was established and the buffer allocated, false otherwise.
165165
bool allocateBuffer();
166166

167-
// Initialize the driver and the display.
168-
// Returns true on success. Returns false on failure (no display detected etc).
167+
// Allocates the buffer and initializes the driver & display. Resets the display!
168+
// Returns false if buffer allocation failed, true otherwise.
169169
bool init();
170170

171171
// Free the memory used by the display

0 commit comments

Comments
 (0)