Skip to content

Commit aea8ba8

Browse files
author
brentru
committed
add headers to all .cpp
1 parent 3d18645 commit aea8ba8

7 files changed

Lines changed: 100 additions & 70 deletions

‎src/AdafruitIO_Dashboard.cpp‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Dashboard.cpp
3+
*
4+
*
5+
* Adafruit invests time and resources providing this open source code.
6+
* Please support Adafruit and open source hardware by purchasing
7+
* products from Adafruit!
8+
*
9+
* Copyright (c) 2015-2016 Adafruit Industries
10+
* Authors: Tony DiCola, Todd Treece
11+
* Licensed under the MIT license.
12+
*
13+
* All text above must be included in any redistribution.
14+
*
15+
*/
1216
#include "AdafruitIO_Dashboard.h"
1317
#include "AdafruitIO.h"
1418

‎src/AdafruitIO_Data.cpp‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece, Adam Bachman
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Data.cpp
3+
*
4+
*
5+
* Adafruit invests time and resources providing this open source code.
6+
* Please support Adafruit and open source hardware by purchasing
7+
* products from Adafruit!
8+
*
9+
* Copyright (c) 2015-2016 Adafruit Industries
10+
* Authors: Tony DiCola, Todd Treece
11+
* Licensed under the MIT license.
12+
*
13+
* All text above must be included in any redistribution.
14+
*
15+
*/
1216
#include "AdafruitIO_Data.h"
1317
#include "AdafruitIO_Feed.h"
1418

‎src/AdafruitIO_Feed.cpp‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece, Adam Bachman
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Feed.cpp
3+
*
4+
*
5+
* Adafruit invests time and resources providing this open source code.
6+
* Please support Adafruit and open source hardware by purchasing
7+
* products from Adafruit!
8+
*
9+
* Copyright (c) 2015-2016 Adafruit Industries
10+
* Authors: Tony DiCola, Todd Treece
11+
* Licensed under the MIT license.
12+
*
13+
* All text above must be included in any redistribution.
14+
*
15+
*/
1216
#include "AdafruitIO_Feed.h"
1317
#include "AdafruitIO.h"
1418

‎src/AdafruitIO_Feed.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class AdafruitIO_Feed : public AdafruitIO_MQTT {
6666
const char *owner; /*!< Adafruit IO feed owner. */
6767

6868
AdafruitIO_Data *lastValue(); /*!< Last value sent to Adafruit IO feed. */
69-
AdafruitIO_Data *data; /*!< Adafruit IO feed data point */
69+
AdafruitIO_Data *data; /*!< Adafruit IO feed data record. */
7070

7171
private:
7272
AdafruitIODataCallbackType _dataCallback; /*!< Callback from onMessage containing data. */
@@ -80,7 +80,7 @@ class AdafruitIO_Feed : public AdafruitIO_MQTT {
8080

8181
Adafruit_MQTT_Subscribe *_sub; /*!< MQTT subscription for _topic. */
8282
Adafruit_MQTT_Publish *_pub; /*!< MQTT publish for _topic. */
83-
Adafruit_MQTT_Publish *_get_pub; /*!< MQTT publish to /get topic. */
83+
Adafruit_MQTT_Publish *_get_pub; /*!< MQTT publish to _get_topic. */
8484

8585
AdafruitIO *_io; /*!< An instance of AdafruitIO. */
8686
AdafruitIO_Data *_data; /*!< An instance of AdafruitIO_Data. */

‎src/AdafruitIO_Group.cpp‎

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,31 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Author: Todd Treece
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Group.cpp
3+
*
4+
*
5+
* Adafruit invests time and resources providing this open source code.
6+
* Please support Adafruit and open source hardware by purchasing
7+
* products from Adafruit!
8+
*
9+
* Copyright (c) 2015-2016 Adafruit Industries
10+
* Authors: Tony DiCola, Todd Treece
11+
* Licensed under the MIT license.
12+
*
13+
* All text above must be included in any redistribution.
14+
*
15+
*/
1216
#include "AdafruitIO_Group.h"
1317
#include "AdafruitIO.h"
1418

19+
20+
/**************************************************************************/
21+
/*!
22+
@brief Creates a new instance of an Adafruit IO Feed.
23+
@param *io
24+
Reference to AdafruitIO.
25+
@param *n
26+
Valid feed name.
27+
*/
28+
/**************************************************************************/
1529
AdafruitIO_Group::AdafruitIO_Group(AdafruitIO *io, const char *n)
1630
: AdafruitIO_MQTT() {
1731
_io = io;

‎src/AdafruitIO_Group.h‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -57,28 +57,28 @@ class AdafruitIO_Group : public AdafruitIO_MQTT {
5757
void subCallback(char *val, uint16_t len);
5858
void call(AdafruitIO_Data *d);
5959

60-
const char *name;
61-
const char *owner;
60+
const char *name; /*!< Adafruit IO group name. */
61+
const char *owner; /*!< Adafruit IO username of group owner. */
6262

63-
AdafruitIO_Data *data;
63+
AdafruitIO_Data *data; /*!< Adafruit IO data record. */
6464
AdafruitIO_Data *getFeed(const char *feed);
6565

6666
private:
6767
void _init();
6868

69-
char *_topic;
70-
char *_get_topic;
71-
char *_create_url;
72-
char *_group_url;
69+
char *_topic; /*!< MQTT topic URL.. */
70+
char *_get_topic; /*!< /get topic string. */
71+
char *_create_url; /*!< Create URL string. */
72+
char *_group_url; /*!< Group URL string. */
7373

74-
Adafruit_MQTT_Subscribe *_sub;
75-
Adafruit_MQTT_Publish *_pub;
76-
Adafruit_MQTT_Publish *_get_pub;
74+
Adafruit_MQTT_Subscribe *_sub; /*!< MQTT subscription for _topic. */
75+
Adafruit_MQTT_Publish *_pub; /*!< MQTT publish for _topic. */
76+
Adafruit_MQTT_Publish *_get_pub; /*!< MQTT publish to _get_topic. */
7777

78-
AdafruitIO *_io;
79-
AdafruitIOGroupCallback *_groupCallback;
78+
AdafruitIO *_io; /*!< An instance of AdafruitIO. */
79+
AdafruitIOGroupCallback *_groupCallback; /*!< An instance of AdafruitIOGroupCallback */
8080

81-
double _lat, _lon, _ele;
81+
double _lat, _lon, _ele; /*!< latitude, longitude, elevation metadata. */
8282
};
8383

8484
#endif // ADAFRUITIO_GROUP_H

‎src/AdafruitIO_Time.cpp‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
//
2-
// Adafruit invests time and resources providing this open source code.
3-
// Please support Adafruit and open source hardware by purchasing
4-
// products from Adafruit!
5-
//
6-
// Copyright (c) 2015-2016 Adafruit Industries
7-
// Authors: Tony DiCola, Todd Treece, Adam Bachman
8-
// Licensed under the MIT license.
9-
//
10-
// All text above must be included in any redistribution.
11-
//
1+
/*!
2+
* @file AdafruitIO_Time.cpp
3+
*
4+
*
5+
* Adafruit invests time and resources providing this open source code.
6+
* Please support Adafruit and open source hardware by purchasing
7+
* products from Adafruit!
8+
*
9+
* Copyright (c) 2015-2016 Adafruit Industries
10+
* Authors: Tony DiCola, Todd Treece
11+
* Licensed under the MIT license.
12+
*
13+
* All text above must be included in any redistribution.
14+
*
15+
*/
1216
#include "AdafruitIO_Time.h"
1317
#include "AdafruitIO.h"
1418

0 commit comments

Comments
 (0)