Update

.gitignore

@@ -41,6 +41,7 @@
 
 #config/googleapi.js
 apidoc
+docs
 
 
 

.travis.yml

@@ -23,6 +23,26 @@ before_install:
 
 script:
   - "grunt coverage"
-
+  - "grunt documentation"
+  - "grunt apidoc"
+  - "mkdir documentation"
+  - "mv docs jsdoc"
+  - "mv ./jsdoc/ ./documentation/"
+  - "mv ./apidoc/ ./documentation/"
+  - echo "<script async src=\"https://www.googletagmanager.com/gtag/js?id=UA-42837031-1\"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-42837031-1'); </script>" >> ./documentation/jsdoc/index.html
+  - echo "<script async src=\"https://www.googletagmanager.com/gtag/js?id=UA-42837031-1\"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-42837031-1'); </script>" >> ./documentation/apidoc/index.html
+
 env:
-  - CXX=g++-4.8
+  - CXX=g++-4.8
+
+deploy:
+ provider: pages
+ repo: GladysProject/documentation
+ skip_cleanup: true
+ github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard
+ local_dir: documentation
+ target-branch: gh-pages
+ fqdn: documentation.gladysproject.com
+ verbose: true
+ on:
+   branch: master

api/controllers/DeviceTypeController.js

@@ -80,6 +80,7 @@ module.exports = {
    * @apiName execDeviceType
    * @apiGroup DeviceType
    * @apiPermission authenticated
+   * @apiDescription This API is not for sensors ! It's only for devices that need to execute an action. Ex: A lamp. If you want to save the state of a sensor, you need to use the POST /devicestate route. 
    *
    * @apiParam {float} [value] New value to apply to the deviceType
    * 
@@ -98,7 +99,7 @@ module.exports = {
    * @apiName execDeviceTypeGet
    * @apiGroup DeviceType
    * @apiPermission authenticated
-   *
+   * @apiDescription This API is not for sensors ! It's only for devices that need to execute an action. Ex: A lamp. If you want to save the state of a sensor, you need to use the POST /devicestate route. 
    * @apiParam {float} [value] New value to apply to the deviceType
    * 
    * @apiUse DeviceStateSuccess

api/controllers/MusicController.js

@@ -231,7 +231,7 @@ module.exports = {
     },
 
      /**
-     * @api {post} /music/volum Set Volume 
+     * @api {post} /music/volume Set Volume 
      * @apiName MusicSetVolume
      * @apiGroup Music
      * @apiPermission authenticated

api/core/alarm/alarm.create.js

@@ -1,3 +1,30 @@
+
+/**
+ * @public
+ * @description This function create an alarm
+ * @name gladys.alarm.create
+ * @param {Object} alarm
+ * @param {String} alarm.name The name of the alarm
+ * @param {datetime} alarm.datetime Datetime of the alarm when the alarm is at a specific date
+ * @param {time} alarm.time Time of the alarm when it's a reccurring alarm
+ * @param {integer} alarm.dayofweek The day the alarm should ring (reccurring alarm)
+ * @returns {Alarm} alarm
+ * @example
+ * var alarm = {
+ *      name: 'Monday wake up !',
+ *      time: '08:00',
+ *      dayofweek: 1
+ * };
+ * 
+ * gladys.alarm.create(alarm)
+ *      .then(function(alarm){
+ *          // alarm created !
+ *      })
+ *      .catch(function(err){
+ *          // something bad happened ! :/
+ *      });
+ */
+
 module.exports = function create(alarm) {
 
     if (!(alarm && ( (alarm.dayofweek && alarm.time) || alarm.cronrule || alarm.datetime || alarm.autoWakeUp)) ){

api/core/alarm/alarm.delete.js

@@ -1,5 +1,26 @@
 var queries = require('./alarm.queries.js');
 
+/**
+ * @public
+ * @description This function delete an alarm
+ * @name gladys.alarm.delete
+ * @param {Object} alarm
+ * @param {integer} alarm.id The id of alarm
+ * @returns {Alarm} alarm
+ * @example
+ * var alarm = {
+ *      id: 1,
+ * };
+ * 
+ * gladys.alarm.delete(alarm)
+ *      .then(function(alarm){
+ *         // alarm deleted ! 
+ *      })
+ *      .catch(function(err){
+ *          // something bad happened ! :/
+ *      });
+ */
+
 module.exports = function(alarm) {
 
     if (!alarm.id) {

api/core/alarm/alarm.get.js

@@ -1,5 +1,26 @@
 var queries = require('./alarm.queries.js');
 
+/**
+ * @public
+ * @description This function retunr all alarm of user
+ * @name gladys.alarm.get
+ * @param {Object} user
+ * @param {integer} user.id The id of the user whose alarms we want
+ * @returns {Array<alarms>} alarm
+ * @example
+ * var user = {
+ *      id: 1,
+ * };
+ * 
+ * gladys.alarm.get(user)
+ *      .then(function(alarms){
+ *         // all alarms of this user ! 
+ *      })
+ *      .catch(function(err){
+ *          // something bad happened ! :/
+ *      });
+ */
+
 module.exports = function(user){
     return gladys.utils.sql(queries.get, [user.id]);
 };

api/core/alarm/alarm.update.js

@@ -1,4 +1,36 @@
 // update an alarm
+
+/**
+ * @private
+ * @description This function update an alarm
+ * @name gladys.alarm.update
+ * @param {Object} params
+ * @param {integer} params.id The id of alarm
+ * @param {Object} params.alarm 
+ * @param {String} params.alarm.name The name of the alarm
+ * @param {datetime} params.alarm.datetime Datetime of the alarm when the alarm is at a specific date
+ * @param {time} params.alarm.time Time of the alarm when it's a reccurring alarm
+ * @param {integer} params.alarm.dayofweek The day the alarm should ring (reccurring alarm)
+ * @returns {Alarm} alarm
+ * @example
+ * var params = {
+ *      id: 1,
+ *      alarm = {
+ *          name: 'Monday wake up !',
+ *          time: '08:00',
+ *          dayofweek: 1
+ *      }
+ * };
+ * 
+ * gladys.alarm.update(params)
+ *      .then(function(alarm){
+ *         // alarm updated ! 
+ *      })
+ *      .catch(function(err){
+ *          // something bad happened ! :/
+ *      });
+ */
+
 module.exports = function(params) {
     return Alarm.update({
             id: params.id