Diff: play_buzzer.h

Revision:

5:d879dead6768

Parent:

1:50204a498764

Child:

6:9ab8c4b24da7

diff -r ce24253309cc -r d879dead6768 play_buzzer.h
--- a/play_buzzer.h	Thu Jan 10 08:35:15 2019 +0000
+++ b/play_buzzer.h	Fri Jan 11 07:53:12 2019 +0000
@@ -1,20 +1,31 @@
+/**
+* @file play_buzzer.cpp
+* @brief this cpp file is where all the logic is handled
+*
+* @author Nikolaj M. & Mathias R.
+*
+* @date 10/1/2019
+*/
+
+//PROGRAM: play_buzzer
 #ifndef PLAY_BUZZER_H
-#define MBED_BEEP_H
+#define PLAY_BUZZER_H
+
+#include m_bed
  
-#include "mbed.h"
 
 namespace mbed {
-//NAME OF CLASS
+///play_buzzer CLASS
 class play_buzzer {
  
-//INITIALIZE VARIABLES USED IN CLASS
+///INITIALIZE VARIABLES USED IN CLASS
 private :
     PinName _pin;
     PwmOut _pwm;
     Timeout toff;
-//FUNCTIONS AND CONSTRUCTOR
+///FUNCTIONS AND CONSTRUCTOR
 public:
-    play_buzzer(PinName);
+    void play_buzzer(PinName);
     void beep (int notes, int tones);
     void nobeep();
     int play(int song);