X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fbuzzerled.h;h=4ef919e33ec7436efc913506ffd04251a7003c35;hb=be5afe05ba0c8a2c885ee9b5a7251ac95d11ac20;hp=aa1c7afdfe4bdd5073327dece092c05a33759128;hpb=76c53bfa0136be55cf17e57b1ee098e5dfeefa70;p=bertos.git diff --git a/drv/buzzerled.h b/drv/buzzerled.h old mode 100755 new mode 100644 index aa1c7afd..4ef919e3 --- a/drv/buzzerled.h +++ b/drv/buzzerled.h @@ -1,9 +1,34 @@ -/*! +/** * \file * * * \brief Generic library to handle buzzers and leds @@ -15,6 +40,9 @@ /*#* *#* $Log$ + *#* Revision 1.8 2006/07/19 12:56:25 bernie + *#* Convert to new Doxygen style. + *#* *#* Revision 1.7 2005/11/04 16:20:02 bernie *#* Fix reference to README.devlib in header. *#* @@ -41,9 +69,9 @@ #ifndef DRV_BUZZERLED_H #define DRV_BUZZERLED_H -#include +#include -/*! Include hw.h. We expect hw.h to define enum BLD_DEVICE, which must contain +/** Include hw.h. We expect hw.h to define enum BLD_DEVICE, which must contain * an enumarator for each device, plus a special symbol NUM_BLDS containing the * number of devices. */ @@ -57,14 +85,14 @@ #include CPU_HEADER(buzzerled) -/*! Initialize the buzzerled library. +/** Initialize the buzzerled library. * * \note This function must be called before any other function in the library. */ void bld_init(void); -/*! Set or reset a device. +/** Set or reset a device. * * \param device Device to be set * \param enable Enable/disable status @@ -72,7 +100,7 @@ void bld_init(void); #define bld_set(device, enable) bld_hw_set(device, enable) -/*! Enable a device for a certain interval of time +/** Enable a device for a certain interval of time * * \param device Device to be enabled * \param duration Number of milliseconds the device must be enabled @@ -82,7 +110,7 @@ void bld_init(void); void bld_beep(enum BLD_DEVICE device, uint16_t duration); -/*! Enable a device for a certain interval of time and wait. +/** Enable a device for a certain interval of time and wait. * * \param device Device to be enabled * \param duration Number of milliseconds the device must be enabled