/**
-\mainpage libserialport API
+@mainpage libserialport API
Introduction
============
The operations that are supported are:
-- \ref Enumeration (obtaining a list of serial ports on the system).
-- \ref Ports
-- \ref Configuration (baud rate, parity, etc)
-- \ref Data
-- \ref Errors
+- @ref Enumeration (obtaining a list of serial ports on the system).
+- @ref Ports
+- @ref Configuration (baud rate, parity, etc)
+- @ref Data
+- @ref Errors
libserialport is an open source project released under the LGPL3+ license.
Most functions take a pointer to a struct sp_port, which represents a serial
port. These structures are always allocated and freed by the library, using
-the functions in the \ref Enumeration "Enumeration" section.
+the functions in the @ref Enumeration "Enumeration" section.
All functions can return only three possible error values. SP_ERR_ARG indicates
the function was called with invalid arguments. SP_ERR_FAIL indicates that the
struct sp_port {
/** Name used to open the port */
char *name;
-/** \cond 0 */
+/** @cond 0 */
/* OS-specific port handle */
#ifdef _WIN32
HANDLE hdl;
#else
int fd;
#endif
-/** \endcond */
+/** @endcond */
};
/** Configuration for a serial port. */
};
/**
-\defgroup Enumeration Port enumeration
+@defgroup Enumeration Port enumeration
@{
*/
/**
@}
-\defgroup Ports Opening & closing ports
+@defgroup Ports Opening & closing ports
@{
*/
/**
@}
-\defgroup Configuration Setting port parameters
+@defgroup Configuration Setting port parameters
@{
*/
/**
@}
-\defgroup Data Reading, writing & flushing data
+@defgroup Data Reading, writing & flushing data
@{
*/
/**
@}
-\defgroup Errors Obtaining error information
+@defgroup Errors Obtaining error information
@{
*/