Skip to content

Commit fa61dc3

Browse files
author
brentru
committed
fix http status @return code
1 parent 5ea635c commit fa61dc3

5 files changed

Lines changed: 11 additions & 14 deletions

File tree

src/AdafruitIO.cpp

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -417,12 +417,10 @@ char *AdafruitIO::userAgent() {
417417

418418
/**************************************************************************/
419419
/*!
420-
@brief MQTT status check.
420+
@brief Checks connection status with Adafruit IO's MQTT broker.
421421
@param fail_fast
422-
Set true to skip retries and return with status immediately,
423-
optional.
424-
@return An MQTT status value. Lower values represent poorer connection
425-
status.
422+
Set true to skip retries and return with status immediately.
423+
@return True if connected, otherwise False.
426424
*/
427425
/**************************************************************************/
428426
aio_status_t AdafruitIO::mqttStatus(bool fail_fast) {

src/AdafruitIO_Dashboard.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ AdafruitIO_Dashboard::~AdafruitIO_Dashboard() {}
3636
/*!
3737
@brief Checks if Adafruit IO Dashboard exists.
3838
https://io.adafruit.com/api/docs/#return-dashboard
39-
@return HTTP response status code, 200 if OK.
39+
@return True if successful, otherwise False.
4040
*/
4141
/**************************************************************************/
4242
bool AdafruitIO_Dashboard::exists() {
@@ -60,7 +60,7 @@ bool AdafruitIO_Dashboard::exists() {
6060
/*!
6161
@brief Creates a new dashboard.
6262
https://io.adafruit.com/api/docs/#create-a-dashboard
63-
@return HTTP response status code, 201 if OK.
63+
@return True if successful, otherwise False.
6464
*/
6565
/**************************************************************************/
6666
bool AdafruitIO_Dashboard::create() {

src/AdafruitIO_Ethernet.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ class AdafruitIO_Ethernet : public AdafruitIO {
5656
/*!
5757
@brief Checks the connection status between the Ethernet
5858
FeatherWing and Adafruit IO
59-
@return AIO_NET_CONNECTED if connected to Adafruit IO,
60-
otherwise AIO_NET_DISCONNECTED.
59+
@return True if connected to Adafruit IO, otherwise False.
6160
*/
6261
/**************************************************************************/
6362
aio_status_t networkStatus() {

src/AdafruitIO_Feed.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ bool AdafruitIO_Feed::save(double value, double lat, double lon, double ele,
279279
/*!
280280
@brief Publishes a null character to an Adafruit IO /get topic.
281281
https://io.adafruit.com/api/docs/mqtt.html#using-the-get-topic
282-
@return HTTP status code 200.
282+
@return True if successful, otherwise False.
283283
*/
284284
/****************************************************************************/
285285
bool AdafruitIO_Feed::get() { return _get_pub->publish("\0"); }
@@ -288,7 +288,7 @@ bool AdafruitIO_Feed::get() { return _get_pub->publish("\0"); }
288288
/*!
289289
@brief Checks if Adafruit IO Feed exists and belongs to username.
290290
https://io.adafruit.com/api/docs/#get-feed
291-
@return HTTP status code 200.
291+
@return True if successful, otherwise False.
292292
*/
293293
/****************************************************************************/
294294
bool AdafruitIO_Feed::exists() {
@@ -307,7 +307,7 @@ bool AdafruitIO_Feed::exists() {
307307
/*!
308308
@brief Creates a new Adafruit IO Feed
309309
https://io.adafruit.com/api/docs/#create-feed
310-
@return HTTP status code 201.
310+
@return True if successful, otherwise False.
311311
*/
312312
/*************************************************************/
313313
bool AdafruitIO_Feed::create() {

src/AdafruitIO_Group.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ void AdafruitIO_Group::setLocation(double lat, double lon, double ele) {
432432
/*!
433433
@brief Checks if Adafruit IO Group exists.
434434
https://io.adafruit.com/api/docs/#get-group
435-
@return HTTP status, 200 if group exists.
435+
@return True if successful, otherwise False.
436436
*/
437437
/**************************************************************************/
438438
bool AdafruitIO_Group::exists() {
@@ -450,7 +450,7 @@ bool AdafruitIO_Group::exists() {
450450
/*!
451451
@brief Creates new Adafruit IO Group.
452452
https://io.adafruit.com/api/docs/#create-group
453-
@return HTTP status, 201 if group created successfully.
453+
@return True if successful, otherwise False.
454454
*/
455455
/**************************************************************************/
456456
bool AdafruitIO_Group::create() {

0 commit comments

Comments
 (0)