Definition of improvements to be made

Ultrasonick.cpp

@@ -4,6 +4,9 @@
   Released into the Creative Commons Attribution-ShareAlike 4.0 International.
 */
 
+/**
+* TODO: Consider removing compatibility for the old Arduino API
+*/
 #if (ARDUINO >= 100)
   #include "Arduino.h"
 #else
@@ -28,6 +31,10 @@ int Ultrasonick::timing() {
   return pulseIn(_echoPin, HIGH); // duration
 }
 
+/**
+* TODO: Enable the change of sound velocity constants
+* TODO: Change the variable type to a minnor size
+*/
 int Ultrasonick::distanceRead(int und) {
   if (und)
     return timing() / 28 / 2 ; //distance in CM

Ultrasonick.h

@@ -1,3 +1,13 @@
+/**
+* TODO: Change license to BSD-3-Clause
+*/
+
+/**
+* TODO: Update layout of folders and files follows the new
+* specification of libraries.
+* https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification
+*/
+
 /*
   Ultrasonick.h - Library for HC-SR04 Ultrasonic Ranging Module in a minimalist way.
   Created by EricK Simoes (@AloErickSimoes), April 3, 2014.
@@ -16,6 +26,11 @@
 #define CM 1
 #define INC 0
 
+/**
+* TODO: Consider discontinuing use of classes and using structures
+* TODO: Remove the underscore of the private variables name
+* and use static keyword
+*/
 class Ultrasonick {
   public:
     Ultrasonick(int trigPin, int echoPin);