Skip to content
This repository was archived by the owner on Mar 17, 2025. It is now read-only.

Commit 65ec1bf

Browse files
committed
firebase: better docstrings
1 parent 52e7a7f commit 65ec1bf

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Firebase.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,19 @@ class Firebase {
3737
Firebase(const String& host);
3838
Firebase& auth(const String& auth);
3939

40-
// Fetch value at "path".
40+
// Fetch json encoded `value` at `path`.
4141
FirebaseGet get(const String& path);
4242

43-
// Set value at "path".
44-
FirebaseSet set(const String& path, const String& value);
43+
// Set json encoded `value` at `path`.
44+
FirebaseSet set(const String& path, const String& json);
4545

46-
// Add new value to list at "path".
47-
FirebasePush push(const String& path, const String& value);
46+
// Add new json encoded `value` to list at `path`.
47+
FirebasePush push(const String& path, const String& json);
4848

49-
// Delete value at "path".
49+
// Delete value at `path`.
5050
FirebaseRemove remove(const String& path);
5151

52-
// Start a stream of events that affect value at "path".
52+
// Start a stream of events that affect value at `path`.
5353
FirebaseStream stream(const String& path);
5454

5555
private:
@@ -146,7 +146,7 @@ class FirebaseStream : public FirebaseCall {
146146
FirebaseStream(const String& host, const String& auth,
147147
const String& path, HTTPClient* http = NULL);
148148

149-
// Return if there is events available to read.
149+
// Return if there is any event available to read.
150150
bool available();
151151

152152
// Event type.
@@ -156,7 +156,7 @@ class FirebaseStream : public FirebaseCall {
156156
PATCH
157157
};
158158

159-
// Read next event from the stream.
159+
// Read next json encoded `event` from stream.
160160
Event read(String& event);
161161

162162
const FirebaseError& error() const {

0 commit comments

Comments
 (0)