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

Commit 04829ad

Browse files
committed
FirebaseArduino: capitalize doc strings
1 parent e5ae1f4 commit 04829ad

File tree

1 file changed

+6
-25
lines changed

1 file changed

+6
-25
lines changed

src/FirebaseArduino.h

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class FirebaseArduino {
4242
* Equivalent to the REST API's POST.
4343
* You should check success() after calling.
4444
* \param path The path of the parent node.
45-
* \param value integer value that you wish to append to the node.
45+
* \param value Integer value that you wish to append to the node.
4646
* \return The unique key of the new child node.
4747
*/
4848
String pushInt(const String& path, int value);
@@ -52,7 +52,7 @@ class FirebaseArduino {
5252
* Equivalent to the REST API's POST.
5353
* You should check success() after calling.
5454
* \param path The path of the parent node.
55-
* \param value float value that you wish to append to the node.
55+
* \param value Float value that you wish to append to the node.
5656
* \return The unique key of the new child node.
5757
*/
5858
String pushFloat(const String& path, float value);
@@ -62,7 +62,7 @@ class FirebaseArduino {
6262
* Equivalent to the REST API's POST.
6363
* You should check success() after calling.
6464
* \param path The path of the parent node.
65-
* \param value bool value that you wish to append to the node.
65+
* \param value Bool value that you wish to append to the node.
6666
* \return The unique key of the new child node.
6767
*/
6868
String pushBool(const String& path, bool value);
@@ -77,16 +77,6 @@ class FirebaseArduino {
7777
*/
7878
String pushString(const String& path, const String& value);
7979

80-
/**
81-
* Appends the String value to the node at path.
82-
* Equivalent to the REST API's POST.
83-
* You should check success() after calling.
84-
* \param path The path of the parent node.
85-
* \param value String value that you wish to append to the node.
86-
* \return The unique key of the new child node.
87-
*/
88-
String pushString(const String& path, const char* value);
89-
9080
/**
9181
* Appends the JSON data to the node at path.
9282
* Equivalent to the REST API's POST.
@@ -102,7 +92,7 @@ class FirebaseArduino {
10292
* REST API's PUT.
10393
* You should check success() after calling.
10494
* \param path The path inside of your db to the node you wish to update.
105-
* \param value integer value that you wish to write.
95+
* \param value Integer value that you wish to write.
10696
*/
10797
void setInt(const String& path, int value);
10898

@@ -111,7 +101,7 @@ class FirebaseArduino {
111101
* REST API's PUT.
112102
* You should check success() after calling.
113103
* \param path The path inside of your db to the node you wish to update.
114-
* \param value float value that you wish to write.
104+
* \param value Float value that you wish to write.
115105
*/
116106
void setFloat(const String& path, float value);
117107

@@ -120,7 +110,7 @@ class FirebaseArduino {
120110
* REST API's PUT.
121111
* You should check success() after calling.
122112
* \param path The path inside of your db to the node you wish to update.
123-
* \param value float value that you wish to write.
113+
* \param value Bool value that you wish to write.
124114
*/
125115
void setBool(const String& path, bool value);
126116

@@ -133,15 +123,6 @@ class FirebaseArduino {
133123
*/
134124
void setString(const String& path, const String& value);
135125

136-
/**
137-
* Writes the String value to the node located at path equivalent to the
138-
* REST API's PUT.
139-
* You should check success() after calling.
140-
* \param path The path inside of your db to the node you wish to update.
141-
* \param value String value that you wish to write.
142-
*/
143-
void setString(const String& path, const char* value);
144-
145126
/**
146127
* Writes the JSON data to the node located at path.
147128
* Equivalent to the REST API's PUT.

0 commit comments

Comments
 (0)