doxygen @ tags replaced to \

This commit is contained in:
2022-03-14 21:19:31 +03:00
parent 9bf1a11701
commit 54b5372356
142 changed files with 1079 additions and 1079 deletions

View File

@@ -1,5 +1,5 @@
/*! @file piserial.h
* @brief Serial device
/*! \file piserial.h
* \brief Serial device
*/
/*
PIP - Platform Independent Primitives
@@ -34,14 +34,14 @@ public:
//! Contructs an empty %PISerial
explicit PISerial();
//! @brief Parameters of PISerial
//! \brief Parameters of PISerial
enum Parameters {
ParityControl /*! Enable parity check and generate */ = 0x1,
ParityOdd /*! Parity is odd instead of even */ = 0x2,
TwoStopBits /*! Two stop bits instead of one */ = 0x4
};
//! @brief Speed of PISerial
//! \brief Speed of PISerial
enum Speed {
S50 /*! 50 baud */ = 50,
S75 /*! 75 baud */ = 75,
@@ -72,26 +72,26 @@ public:
S4000000 /*! 4000000 baud */ = 4000000
};
//! @brief Information about serial device
//! \brief Information about serial device
struct PIP_EXPORT DeviceInfo {
DeviceInfo();
//! @brief String representation of USB ID in format \"xxxx:xxxx\"
//! \brief String representation of USB ID in format \"xxxx:xxxx\"
PIString id() const;
//! @brief USB Vendor ID
//! \brief USB Vendor ID
uint vID;
//! @brief USB Product ID
//! \brief USB Product ID
uint pID;
//! @brief Path to device, e.g. "COM2" or "/dev/ttyUSB0"
//! \brief Path to device, e.g. "COM2" or "/dev/ttyUSB0"
PIString path;
//! @brief Device description
//! \brief Device description
PIString description;
//! @brief Device manufacturer
//! \brief Device manufacturer
PIString manufacturer;
};
@@ -187,42 +187,42 @@ public:
PIString read(int size = -1, double timeout_ms = 1000.);
PIByteArray readData(int size = -1, double timeout_ms = 1000.);
//! @brief Write to device data "data" with maximum size "size" and wait for data written if "wait" is \b true.
//! \brief Write to device data "data" with maximum size "size" and wait for data written if "wait" is \b true.
//! \returns \b true if sended bytes count = "size"
bool send(const void * data, int size);
//! @brief Write to device byte array "data"
//! \brief Write to device byte array "data"
//! \returns \b true if sended bytes count = size of string
bool send(const PIByteArray & data) {return send(data.data(), data.size_s());}
//! @brief Returns all available speeds for serial devices
//! \brief Returns all available speeds for serial devices
static PIVector<int> availableSpeeds();
//! @brief Returns all available system devices path. If "test" each device will be tried to open
//! \brief Returns all available system devices path. If "test" each device will be tried to open
static PIStringList availableDevices(bool test = false);
//! @brief Returns all available system devices. If "test" each device will be tried to open
//! \brief Returns all available system devices. If "test" each device will be tried to open
static PIVector<DeviceInfo> availableDevicesInfo(bool test = false);
//! \ioparams
//! \{
#ifdef DOXYGEN
//! @brief device, default ""
//! \brief device, default ""
string device;
//! @brief input/output speed, default 115200
//! \brief input/output speed, default 115200
int speed;
//! @brief dataBitsCount, default 8
//! \brief dataBitsCount, default 8
int dataBitsCount;
//! @brief parityControl, default false
//! \brief parityControl, default false
bool parityControl;
//! @brief parityOdd, default false
//! \brief parityOdd, default false
bool parityOdd;
//! @brief twoStopBits, default false
//! \brief twoStopBits, default false
bool twoStopBits;
#endif
//! \}