X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fbuzzerled.h;h=012def4ea9069a07c16d351fca6535feb41b6b94;hb=f4c89bc436e098ec88d46c1cf57f134814f35ee3;hp=d361444d167da3c5553bd0fc2c60ffb6f3fa81cb;hpb=af9c555446161016fdd76c1cdff96ce76bb6cba2;p=bertos.git diff --git a/drv/buzzerled.h b/drv/buzzerled.h index d361444d..012def4e 100755 --- a/drv/buzzerled.h +++ b/drv/buzzerled.h @@ -1,9 +1,9 @@ -/*! +/** * \file * * * \brief Generic library to handle buzzers and leds @@ -15,6 +15,12 @@ /*#* *#* $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. + *#* *#* Revision 1.6 2005/04/11 19:10:27 bernie *#* Include top-level headers from cfg/ subdir. *#* @@ -40,7 +46,7 @@ #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. */ @@ -54,14 +60,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 @@ -69,7 +75,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 @@ -79,7 +85,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