libftdi: (tomj) polished documentation, started "examples" dir

[libftdi] / src / ftdi.c

diff --git a/src/ftdi.c b/src/ftdi.c
index 0b8b269..8399030 100644 (file)
--- a/src/ftdi.c
+++ b/src/ftdi.c
@@ -14,6 +14,20 @@
  *                                                                         *
  ***************************************************************************/
 
+/**
+    \mainpage libftdi API documentation
+
+    Library to talk to FTDI chips. You find the latest versions of libftdi at
+    http://www.intra2net.com/de/produkte/opensource/ftdi/
+
+    The library is easy to use. Have a look at this short example:
+    \include simple.c
+
+    More examples can be found in the "examples" directory.
+*/
+/** \addtogroup libftdi */
+/* @{ */
+
 #include <usb.h>
 #include <string.h>
 #include <errno.h>
@@ -402,6 +416,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)
@@ -1273,3 +1288,5 @@ int ftdi_setrts(struct ftdi_context *ftdi, int state)
 
     return 0;
 }
+
+/* @} end of doxygen libftdi group */