Revision 2:5191c0e163d6, committed 2017-06-28

Comitter:

mpuric

Date:

Wed Jun 28 18:35:29 2017 +0000

Parent:

1:ea7f0ef29ef5

Commit message:

added api doc

Changed in this revision

diff -r ea7f0ef29ef5 -r 5191c0e163d6 ThingSpeak.h
--- a/ThingSpeak.h	Thu Jun 08 18:28:20 2017 +0000
+++ b/ThingSpeak.h	Wed Jun 28 18:35:29 2017 +0000
@@ -28,18 +28,20 @@
 {
 
 public:
-    /**
-     * @param: write api key provided from ThingSpeak chanell
+    /** Write api key provided from ThingSpek channel.
+     * @param: write api key provided from ThingSpeak channel.
     */
     ThingSpeak(char*);
     /**
-     * Establishing ethernet connection until connected
+     * Establishing ethernet connection until connected.
      *
     */
     void connect();
     
     /**
-    *   Added a function for pulling data from ThingSpeak.
+    *   Funkcion for pulling data from ThingSpeak.
+    *   @param readKey Channel feed number
+    *   @param Field number.
     */
     float pull(long int, int);
     
@@ -48,8 +50,8 @@
     /**
      *Setting values to the field, they should be set in order.
      * It's not required to set them all  (example: you can set 1, 2, 3 or 1, 3)
-     * @param field value to store on
-     * @param i number of a field
+     * @param Field value to store on.
+     * @param i number of a field.
     */
     void setField(float field, int i);
 private: