seiichi horie / shimabara

Dependents:   unzen_sample_LPC4088_quickstart unzen_sample_lpcxpresso_4337_callbacks unzen_sample_nucleo_f746 unzen_delay_sample_nucleo_f746 ... more

Files at this revision

API Documentation at this revision

Comitter:
shorie
Date:
Thu Jan 26 00:07:02 2017 +0000
Parent:
4:a838173c951d
Child:
6:caf53d91e237
Commit message:
Doxygen comment updated

Changed in this revision

baseaudiocodec.h Show annotated file Show diff for this revision Revisions of this file
--- a/baseaudiocodec.h	Fri May 27 04:58:41 2016 +0000
+++ b/baseaudiocodec.h	Thu Jan 26 00:07:02 2017 +0000
@@ -1,5 +1,5 @@
-/*
-* \file BaseAudioCodec.h
+/**
+* \file baseaudiocodec.h
 * \brief header file for an abstract audio codec class
 * \arthur SeiichiHorie
 * \date 6/Apr/2016
@@ -16,10 +16,15 @@
 {
 
 
-        // Sampling Frequency of the umb_adau1361
+        /**
+         * \brief Sampling Frequency of the umb_adau1361
+         */
     enum Fs_Type 
     {
-        Fs_32, Fs_441, Fs_48, Fs_96
+        Fs_32,  ///< 32kHz
+        Fs_441, ///< 44.1kHz
+        Fs_48,  ///< 48kHz
+        Fs_96   ///< 96kHz
     } ;