diff --git a/src/lib/tunes/tunes.cpp b/src/lib/tunes/tunes.cpp index e1ebd0c10e..9b8f90735c 100644 --- a/src/lib/tunes/tunes.cpp +++ b/src/lib/tunes/tunes.cpp @@ -149,7 +149,7 @@ void Tunes::set_string(const char *string) int Tunes::get_next_tune(unsigned &frequency, unsigned &duration, unsigned &silence) { - // Return the vaules for frequency and duration if the custom msg was recieved + // Return the vaules for frequency and duration if the custom msg was received if (_using_custom_msg) { _using_custom_msg = false; frequency = _frequency; diff --git a/src/lib/tunes/tunes.h b/src/lib/tunes/tunes.h index 516361d8cf..50f031c2f6 100644 --- a/src/lib/tunes/tunes.h +++ b/src/lib/tunes/tunes.h @@ -64,15 +64,15 @@ public: ~Tunes() = default; /** - * Set tune to be played + * Set tune to be played. * * @param tune_control struct containig the uORB message */ void set_control(const tune_control_s &tune_control); /** - * parse a tune string, formatted with the syntax of the Microsoft GWBasic/QBasic, in frequency(Hz), - * duration(us) and silence(us). + * Parse a tune string, formatted with the syntax of the Microsoft GWBasic/QBasic. + * This has to be kept in memory for the whole duration of the melody. * * @param string tune input string */ @@ -129,18 +129,28 @@ private: */ unsigned note_duration(unsigned &silence, unsigned note_length, unsigned dots); - // Calculate the duration in microseconds of a rest corresponding to - // a given note length. - // + /** + * Calculate the duration in microseconds of a rest corresponding to + * a given note length. + * + * @param rest_length rest lenght in fraction of a note + * @param dots number of extension dots + * @return rest duration (us) + */ unsigned rest_duration(unsigned rest_length, unsigned dots); - // Find the next character in the string, discard any whitespace and - // return the canonical (uppercase) version. - // + /** + * Find the next character in the string, discard any whitespace. + * + * @return uppercase version of the char. + */ int next_char(); - // Extract a number from the string, consuming all the digit characters. - // + /** + * Extract a number from the string, consuming all the digit characters. + * + * @return extracted number. + */ unsigned next_number(); /**