libftdi: (tomj) finishing touches on API documentation

[libftdi] / src / ftdi.c

diff --git a/src/ftdi.c b/src/ftdi.c
index f5145ef..df7daaf 100644 (file)
--- a/src/ftdi.c
+++ b/src/ftdi.c
@@ -14,6 +14,18 @@
  *                                                                         *
  ***************************************************************************/
 
+/**
+    \mainpage libftdi API documentation
+
+    Library to talk to FTDI chips. See http://www.ftdichip.com
+
+    The latest versions of libftdi is available at
+    http://www.intra2net.com/de/produkte/opensource/ftdi/
+
+*/
+/** \addtogroup libftdi */
+/* @{ */
+
 #include <usb.h>
 #include <string.h>
 #include <errno.h>
@@ -248,7 +260,7 @@ int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct usb_device *dev)
     \param vendor Vendor ID
     \param product Product ID
 
-    \retval \see ftdi_usb_open_desc()
+    \retval same as ftdi_usb_open_desc()
 */
 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
 {
@@ -402,6 +414,7 @@ int ftdi_usb_close(struct ftdi_context *ftdi)
 /*
     ftdi_convert_baudrate returns nearest supported baud rate to that requested.
     Function is only used internally
+    \internal
 */
 static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
                                  unsigned short *value, unsigned short *index)
@@ -501,9 +514,10 @@ static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
 }
 
 /**
-    Sets the chip baudrate
+    Sets the chip baud rate
 
     \param ftdi pointer to ftdi_context
+    \param baudrate baud rate to set
 
     \retval  0: all fine
     \retval -1: invalid baudrate
@@ -1197,6 +1211,10 @@ char *ftdi_get_error_string (struct ftdi_context *ftdi)
     return ftdi->error_str;
 }
 
+/*
+    Flow control code by Lorenz Moesenlechner (lorenz@hcilab.org)
+    and Matthias Kranz  (matthias@hcilab.org)
+*/
 /**
     Set flowcontrol for ftdi chip
 
@@ -1268,3 +1286,5 @@ int ftdi_setrts(struct ftdi_context *ftdi, int state)
 
     return 0;
 }
+
+/* @} end of doxygen libftdi group */