SHS/pip
4
3
Fork 0
Code Issues 67 Pull Requests 1 Actions Releases Wiki Activity

rename doc macros

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

10
libs/main/io_devices/piserial.cpp
View File

@@ -138,7 +138,7 @@
/*! \class PISerial
* \brief Serial device
* @brief Serial device
*
* \section PISerial_sec0 Synopsis
* This class provide access to serial device, e.g. COM port. It can read,
@@ -380,7 +380,7 @@ int PISerial::convertSpeed(PISerial::Speed speed) {
}
/** \brief Advanced read function
/** @brief Advanced read function
* \details Read to pointer "read_to" no more than "max_size" and no longer
* than "timeout_ms" milliseconds. If "timeout_ms" < 0 function will be
* wait forever until "max_size" will be readed. If size <= 0 function
@@ -418,7 +418,7 @@ bool PISerial::read(void * data, int size, double timeout_ms) {
}
/** \brief Advanced read function
/** @brief Advanced read function
* \details Read all or no more than "size" and no longer than
* "timeout_ms" milliseconds. If "timeout_ms" < 0 function will be
* wait forever until "size" will be readed. If "size" <= 0
@@ -470,7 +470,7 @@ PIString PISerial::read(int size, double timeout_ms) {
}
/** \brief Advanced read function
/** @brief Advanced read function
* \details Read all or no more than "size" and no longer than
* "timeout_ms" milliseconds. If "timeout_ms" < 0 function will be
* wait forever until "size" will be readed. If "size" <= 0
@@ -686,7 +686,7 @@ void PISerial::setTimeouts() {
}
/** \brief Basic read function
/** @brief Basic read function
* \details Read to pointer "read_to" no more than "max_size". If read is
* set to blocking this function will be wait at least one byte.
* \returns Readed bytes count