X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Fbuzzerled.h;h=012def4ea9069a07c16d351fca6535feb41b6b94;hb=166a481f3faddfa24e3f0e9149a56d8d1e2baefd;hp=bd1a04f98f4a73620d7dd137dffa97bf9c7b17bb;hpb=277b540c0764dd376dcf583acdc97a2b2fd3d8e6;p=bertos.git diff --git a/drv/buzzerled.h b/drv/buzzerled.h index bd1a04f9..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,15 @@ /*#* *#* $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. + *#* *#* Revision 1.5 2004/08/25 14:12:08 rasky *#* Aggiornato il comment block dei log RCS *#* @@ -35,9 +44,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. */ @@ -51,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 @@ -66,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 @@ -76,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