rename doc macros

This commit is contained in:
2021-08-04 16:31:32 +03:00
parent 0c7ce272e6
commit 25def958a1
140 changed files with 963 additions and 983 deletions

View File

@@ -1,5 +1,5 @@
/*! \file piethernet.h
* \brief Ethernet device
/*! @file piethernet.h
* @brief Ethernet device
*/
/*
PIP - Platform Independent Primitives
@@ -42,7 +42,7 @@ public:
//! Contructs UDP %PIEthernet with empty read address
explicit PIEthernet();
//! \brief Type of %PIEthernet
//! @brief Type of %PIEthernet
enum Type {
UDP /** UDP - User Datagram Protocol */ ,
TCP_Client /** TCP client - allow connection to TCP server */ ,
@@ -50,7 +50,7 @@ public:
TCP_SingleTCP /** TCP client single mode - connect & send & disconnect, on each packet */
};
//! \brief Parameters of %PIEthernet
//! @brief Parameters of %PIEthernet
enum Parameters {
ReuseAddress /** Rebind address if there is already binded. Enabled by default */ = 0x1,
Broadcast /** Broadcast send. Disabled by default */ = 0x2,
@@ -62,7 +62,7 @@ public:
};
//! \brief IPv4 network address, IP and port
//! @brief IPv4 network address, IP and port
class PIP_EXPORT Address {
friend class PIEthernet;
public:
@@ -421,37 +421,37 @@ public:
//! \{
//! \fn void newConnection(PIEthernet * client)
//! \brief Raise on new TCP connection received
//! @brief Raise on new TCP connection received
//! \fn void connected()
//! \brief Raise if succesfull TCP connection
//! @brief Raise if succesfull TCP connection
//! \fn void disconnected(bool withError)
//! \brief Raise if TCP connection was closed
//! @brief Raise if TCP connection was closed
//! \}
//! \ioparams
//! \{
#ifdef DOXYGEN
//! \brief read ip, default ""
//! @brief read ip, default ""
string ip;
//! \brief read port, default 0
//! @brief read port, default 0
int port;
//! \brief ethernet parameters
//! @brief ethernet parameters
int parameters;
//! \brief read timeout, default 1000 ms
//! @brief read timeout, default 1000 ms
double readTimeout;
//! \brief write timeout, default 1000 ms
//! @brief write timeout, default 1000 ms
double writeTimeout;
//! \brief time-to-live, default 64
//! @brief time-to-live, default 64
int TTL;
//! \brief time-to-live for multicast, default 1
//! @brief time-to-live for multicast, default 1
int multicastTTL;
#endif
//! \}