# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.
-FULL_PATH_NAMES = YES
+FULL_PATH_NAMES = NO
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
-TAB_SIZE = 8
+TAB_SIZE = 4
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For instance, some of the names that are used will be different. The list
# of all members will be omitted, etc.
-OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_FOR_C = YES
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for Java.
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
-EXTRACT_STATIC = YES
+EXTRACT_STATIC = NO
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.
-HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_MEMBERS = YES
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.
-HIDE_UNDOC_CLASSES = NO
+HIDE_UNDOC_CLASSES = YES
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
Source: %{name}-%{version}.tar.gz
Buildroot: /tmp/%{name}-%{version}-root
Requires: libusb
-BuildRequires: libusb, libusb-devel, pkgconfig
+BuildRequires: libusb, libusb-devel, pkgconfig, doxygen
Prefix: /usr
%package devel
%files devel
%defattr(-,root,root)
+%doc doc/html doc/man
%{prefix}/bin/libftdi-config
%{prefix}/lib/libftdi.*a
%{prefix}/include/*.h
* *
***************************************************************************/
+/**
+ \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>
/*
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)
return 0;
}
+
+/* @} end of doxygen libftdi group */
#define SIO_RTS_CTS_HS (0x1 << 8)
/**
- Main context structure for all libftdi functions.
+ \brief Main context structure for all libftdi functions.
Do not access directly if possible.
*/
};
/**
- Single linked list of usb devices created by ftdi_usb_find_all()
+ \brief list of usb devices created by ftdi_usb_find_all()
*/
struct ftdi_device_list {
/// pointer to next entry
};
/**
- FTDI eeprom structure
+ \brief FTDI eeprom structure
*/
struct ftdi_eeprom {
/// vendor id