Doxygen-ize

server/drivers/hd44780-ftdi.c

@@ -57,8 +57,8 @@ void ftdi_HD44780_close(PrivateData *p);
 /**
  * Initialize the driver.
  * \param drvthis  Pointer to driver structure.
- * \retval 0   Success.
- * \retval -1  Error.
+ * \retval 0       Success.
+ * \retval -1      Error.
  */
 int
 hd_init_ftdi(Driver *drvthis)
@@ -145,7 +145,13 @@ hd_init_ftdi(Driver *drvthis)
 }
 
 
-// ftdi_HD44780_senddata
+/**
+ * Send data or commands to the display.
+ * \param p          Pointer to driver's private data structure.
+ * \param displayID  ID of the display (or 0 for all) to send data to.
+ * \param flags      Defines whether to end a command or data.
+ * \param ch         The value to send.
+ */
 void
 ftdi_HD44780_senddata(PrivateData *p, unsigned char displayID, unsigned char flags, unsigned char ch)
 {
@@ -209,6 +215,11 @@ ftdi_HD44780_senddata(PrivateData *p, unsigned char displayID, unsigned char fla
 }
 
 
+/**
+ * Turn display backlight on or off.
+ * \param p      Pointer to driver's private data structure.
+ * \param state  New backlight status.
+ */
 void
 ftdi_HD44780_backlight(PrivateData *p, unsigned char state)
 {
@@ -227,6 +238,10 @@ ftdi_HD44780_backlight(PrivateData *p, unsigned char state)
 }
 
 
+/**
+ * Close the driver (do necessary clean-up).
+ * \param p  Pointer to driver's private data structure.
+ */
 void
 ftdi_HD44780_close(PrivateData *p)
 {