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

2
libs/main/io_devices/pibinarylog.cpp
View File

@@ -24,7 +24,7 @@
#define PIBINARYLOG_VERSION_OLD 0x31
/*! \class PIBinaryLog
* \brief Class for read and write binary data to logfile, and playback this data in realtime, or custom speed
* @brief Class for read and write binary data to logfile, and playback this data in realtime, or custom speed
*
* \section PIBinaryLog_sec0 Synopsis
* Binary Log is a file with simple header, where you can read and write some binary data.

24
libs/main/io_devices/pibinarylog.h
View File

@@ -1,5 +1,5 @@
/*! \file pibinarylog.h
* \brief Binary log
/*! @file pibinarylog.h
* @brief Binary log
*/
/*
PIP - Platform Independent Primitives
@@ -33,14 +33,14 @@ public:
explicit PIBinaryLog();
virtual ~PIBinaryLog();
//! \brief Play modes for \a PIBinaryLog
//! @brief Play modes for \a PIBinaryLog
enum PlayMode {
PlayRealTime /*! Play in system realtime, default mode */ ,
PlayVariableSpeed /*! Play in software realtime with speed, set by \a setSpeed */ ,
PlayStaticDelay /*! Play with custom static delay, ignoring timestamp */
};
//! \brief Different split modes for writing \a PIBinaryLog, which can separate files by size, by time or by records count
//! @brief Different split modes for writing \a PIBinaryLog, which can separate files by size, by time or by records count
enum SplitMode {
SplitNone /*! Without separate, default mode */ ,
SplitTime /*! Separate files by record time */ ,
@@ -48,7 +48,7 @@ public:
SplitCount /*! Separate files by records count */
};
//! \brief Struct contains information about all records with same ID
//! @brief Struct contains information about all records with same ID
struct PIP_EXPORT BinLogRecordInfo {
BinLogRecordInfo() {
id = count = 0;
@@ -62,7 +62,7 @@ public:
PISystemTime end_time;
};
//! \brief Struct contains full information about Binary Log file and about all Records using map of \a BinLogRecordInfo
//! @brief Struct contains full information about Binary Log file and about all Records using map of \a BinLogRecordInfo
struct PIP_EXPORT BinLogInfo {
PIString path;
int records_count;
@@ -73,7 +73,7 @@ public:
PIByteArray user_header;
};
//! \brief Struct contains position, ID and timestamp of record in file
//! @brief Struct contains position, ID and timestamp of record in file
struct PIP_EXPORT BinLogIndex {
int id;
llong pos;
@@ -249,7 +249,7 @@ public:
//! \{
//! \fn PIString createNewFile()
//! \brief Create new binlog file in \a logDir, if successful returns filename, else returns empty string.
//! @brief Create new binlog file in \a logDir, if successful returns filename, else returns empty string.
//! Filename is like \a filePrefix + "yyyy_MM_dd__hh_mm_ss.binlog"
//! \}
@@ -257,13 +257,13 @@ public:
//! \{
//! \fn void fileEnd()
//! \brief Raise on file end while reading
//! @brief Raise on file end while reading
//! \fn void fileError()
//! \brief Raise on file creation error
//! @brief Raise on file creation error
//! \fn void newFile(const PIString & filename)
//! \brief Raise on new file created
//! @brief Raise on new file created
//! \}
@@ -324,7 +324,7 @@ private:
PIByteArray user_header;
};
//! \relatesalso PICout \brief Output operator PIBinaryLog::BinLogInfo to PICout
//! \relatesalso PICout @brief Output operator PIBinaryLog::BinLogInfo to PICout
inline PICout operator <<(PICout s, const PIBinaryLog::BinLogInfo & bi) {
s.space();
s.setControl(0, true);

4
libs/main/io_devices/pican.h
View File

@@ -1,5 +1,5 @@
/*! \file pican.h
* \brief CAN device
/*! @file pican.h
* @brief CAN device
*/
/*
PIP - Platform Independent Primitives

6
libs/main/io_devices/piconfig.cpp
View File

@@ -26,7 +26,7 @@
# include <iostream>
#endif
/*! \class PIConfig
* \brief Configuration file
* @brief Configuration file
* \details This class provide handle access to configuration file.
*
* \section PIConfig_sec0 Synopsis
@@ -67,7 +67,7 @@
*/
/*! \class PIConfig::Entry
* \brief %Entry of configuration file
* @brief %Entry of configuration file
* \details This class is node of internal PIConfig tree.
* %Entry provide access to elements of PIConfig. Each entry has
* children or next properties:
@@ -91,7 +91,7 @@
*/
/*! \class PIConfig::Branch
* \brief %Branch is a list of entries of configuration file
* @brief %Branch is a list of entries of configuration file
* \details %Branch provides some features to get entries lists.
* \snippet piconfig.cpp PIConfig::Branch
*

62
libs/main/io_devices/piconfig.h
View File

@@ -1,5 +1,5 @@
/*! \file piconfig.h
* \brief Configuration parser and writer
/*! @file piconfig.h
* @brief Configuration parser and writer
*/
/*
PIP - Platform Independent Primitives
@@ -148,7 +148,7 @@ public:
//! Returns comment
const PIString & comment() const {return _comment;}
/** \brief Returns full name, i.e. name as it looks in file
/** @brief Returns full name, i.e. name as it looks in file
* \details In case of default entry full name always is empty
* \snippet piconfig.cpp fullName */
const PIString & fullName() const {return _full_name;}
@@ -205,7 +205,7 @@ public:
Entry & setValue(const double value) {setValue(PIString::fromNumber(value)); setType("f"); return *this;}
/** \brief Returns entry with name "vname" and default value "def"
/** @brief Returns entry with name "vname" and default value "def"
* \details If there is no suitable entry found, reference to default internal entry with
* value = "def" will be returned, and if "exists" not null it will be set to \b false */
Entry & getValue(const PIString & vname, const PIString & def = PIString(), bool * exists = 0);
@@ -213,43 +213,43 @@ public:
PICONFIG_GET_VALUE
//! \fn Entry & getValue(const PIString & vname, const char * def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const char * def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const PIStringList & def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const bool def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const short def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const int def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const long def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const uchar def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const ushort def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const uint def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const ulong def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const float def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const double def, bool * exists = 0)
//! \brief Returns entry with name "vname" and default value "def"
//! @brief Returns entry with name "vname" and default value "def"
//! Find all entries with names with substrings "vname" and returns them as \a PIConfig::Branch
@@ -341,43 +341,43 @@ public:
PICONFIG_GET_VALUE
//! \fn Entry & getValue(const PIString & vname, const char * def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const char * def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const PIStringList & def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const bool def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const short def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const int def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const long def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const uchar def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const ushort def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const uint def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const ulong def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const float def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! \fn Entry & getValue(const PIString & vname, const double def, bool * exists = 0)
//! \brief Returns top-level entry with name "vname" and default value "def"
//! @brief Returns top-level entry with name "vname" and default value "def"
//! Returns top-level entries with names with substrings "vname"
@@ -517,7 +517,7 @@ inline PICout operator <<(PICout s, const PIConfig::Entry & v) {
/** \relatesalso PIConfig \relatesalso PIIODevice
* \brief Service function. useful for configuring devices
* @brief Service function. useful for configuring devices
* \details Function takes entry name "name", default value "def" and two
* \a PIConfig::Entry sections: "em" and their parent "ep". If there is no
* parent ep = 0. If "ep" is not null and entry "name" exists in "ep" function

2
libs/main/io_devices/pidir.cpp
View File

@@ -46,7 +46,7 @@ extern "C" {
#endif
/*! \class PIDir
* \brief Local directory
* @brief Local directory
*
* \section PIDir_sec0 Synopsis
* This class provide access to local file. You can manipulate

10
libs/main/io_devices/pidir.h
View File

@@ -1,5 +1,5 @@
/*! \file pidir.h
* \brief Local directory
/*! @file pidir.h
* @brief Local directory
*/
/*
PIP - Platform Independent Primitives
@@ -57,7 +57,7 @@ public:
//! Returns absolute path of this directory
PIString absolutePath() const;
/** \brief Simplify path of this directory
/** @brief Simplify path of this directory
* \details This function remove repeatedly separators and
* resolve ".." in path. E.g. "/home/.//peri4/src/../.." will
* become "/home" \n This function returns reference to this %PIDir */
@@ -76,7 +76,7 @@ public:
bool setCurrent() {return PIDir::setCurrent(path());}
/** \brief Returns this directory content
/** @brief Returns this directory content
* \details Scan this directory and returns all directories
* and files in one list, sorted alphabetically. This list
* contains also "." and ".." members. There are absolute
@@ -85,7 +85,7 @@ public:
* directories! */
PIVector<PIFile::FileInfo> entries();
/** \brief Returns all this directory content
/** @brief Returns all this directory content
* \details Scan this directory recursively and returns all
* directories and files in one list, sorted alphabetically.
* This list doesn`t contains "." and ".." members. There

2
libs/main/io_devices/piethernet.cpp
View File

@@ -70,7 +70,7 @@
/** \class PIEthernet
* \brief Ethernet device
* @brief Ethernet device
* \details
* \section PIEthernet_sec0 Synopsis
* %PIEthernet designed to work with IPv4 network via two protocols:

30
libs/main/io_devices/piethernet.h
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
//! \}

2
libs/main/io_devices/pifile.cpp
View File

@@ -70,7 +70,7 @@
#endif
/*! \class PIFile
* \brief Local file
* @brief Local file
*
* \section PIFile_sec0 Synopsis
* This class provide access to local file. You can manipulate

12
libs/main/io_devices/pifile.h
View File

@@ -1,5 +1,5 @@
/*! \file pifile.h
* \brief Local file
/*! @file pifile.h
* @brief Local file
*/
/*
PIP - Platform Independent Primitives
@@ -266,16 +266,16 @@ public:
//! \{
//! \fn void clear()
//! \brief Clear content of file
//! @brief Clear content of file
//! \fn void resize(llong new_size)
//! \brief Resize file to "new_size" with "fill" filling
//! @brief Resize file to "new_size" with "fill" filling
//! \fn void resize(llong new_size, uchar fill)
//! \brief Resize file to "new_size" with "fill" filling
//! @brief Resize file to "new_size" with "fill" filling
//! \fn void remove()
//! \brief Remove file
//! @brief Remove file
//! \}
//! \ioparams

2
libs/main/io_devices/pigpio.cpp
View File

@@ -29,7 +29,7 @@
/*! \class PIGPIO
* \brief GPIO support
* @brief GPIO support
*
* \section PIGPIO_sec0 Synopsis
* This class provide initialize, get/set and watch functions for GPIO.

26
libs/main/io_devices/pigpio.h
View File

@@ -1,5 +1,5 @@
/*! \file pigpio.h
* \brief GPIO
/*! @file pigpio.h
* @brief GPIO
*/
/*
PIP - Platform Independent Primitives
@@ -33,41 +33,41 @@ public:
PIGPIO();
virtual ~PIGPIO();
//! \brief Work mode for pin
//! @brief Work mode for pin
enum Direction {
In /** Input direction (read) */,
Out /** Output direction (write) */
};
//! \brief Returns singleton object of %PIGPIO
//! @brief Returns singleton object of %PIGPIO
static PIGPIO * instance();
//! \brief Initialize pin \"gpio_num\" for \"dir\" mode
//! @brief Initialize pin \"gpio_num\" for \"dir\" mode
void initPin(int gpio_num, Direction dir = PIGPIO::In);
//! \brief Set pin \"gpio_num\" value to \"value\"
//! @brief Set pin \"gpio_num\" value to \"value\"
void pinSet (int gpio_num, bool value);
//! \brief Set pin \"gpio_num\" value to \b true
//! @brief Set pin \"gpio_num\" value to \b true
void pinHigh (int gpio_num) {pinSet(gpio_num, true );}
//! \brief Set pin \"gpio_num\" value to \b false
//! @brief Set pin \"gpio_num\" value to \b false
void pinLow (int gpio_num) {pinSet(gpio_num, false);}
//! \brief Returns pin \"gpio_num\" state
//! @brief Returns pin \"gpio_num\" state
bool pinState(int gpio_num);
//! \brief Starts watch for pin \"gpio_num\".
//! @brief Starts watch for pin \"gpio_num\".
//! \details Pins watching starts only with \a PIThread::start() function!
//! This function doesn`t affect thread state
void pinBeginWatch(int gpio_num);
//! \brief End watch for pin \"gpio_num\".
//! @brief End watch for pin \"gpio_num\".
//! \details Pins watching starts only with \a PIThread::start() function!
//! This function doesn`t affect thread state
void pinEndWatch (int gpio_num);
//! \brief End watch for all pins.
//! @brief End watch for all pins.
//! \details Pins watching starts only with \a PIThread::start() function!
//! This function doesn`t affect thread state
void clearWatch();
@@ -78,7 +78,7 @@ public:
//! \{
//! \fn void pinChanged(int gpio_num, bool new_value)
//! \brief Raise on pin \"gpio_num\" state changes to \"new_value\"
//! @brief Raise on pin \"gpio_num\" state changes to \"new_value\"
//! \details Important! This event will be raised only with started
//! thread.

2
libs/main/io_devices/piiobytearray.cpp
View File

@@ -21,7 +21,7 @@
/*! \class PIIOByteArray
* \brief PIIODevice wrapper around PIByteArray
* @brief PIIODevice wrapper around PIByteArray
*
* \section PIIOByteArray_sec0 Synopsis
* This class sllow you to use PIByteArray as PIIODevice and pass it to, e.g. PIConfig

4
libs/main/io_devices/piiobytearray.h
View File

@@ -1,5 +1,5 @@
/*! \file piiobytearray.h
* \brief PIIODevice wrapper around PIByteArray
/*! @file piiobytearray.h
* @brief PIIODevice wrapper around PIByteArray
*/
/*
PIP - Platform Independent Primitives

4
libs/main/io_devices/piiodevice.cpp
View File

@@ -24,7 +24,7 @@
/*! \class PIIODevice
* \brief Base class for input/output classes
* @brief Base class for input/output classes
*
* \section PIIODevice_sec0 Synopsis
* This class provide open/close logic, threaded read/write and virtual input/output
@@ -125,7 +125,7 @@ PIIODevice::PIIODevice(): PIThread() {
}
/*! \brief Constructs a PIIODevice with path and mode
/*! @brief Constructs a PIIODevice with path and mode
* \param path path to device
* \param type mode for open */
PIIODevice::PIIODevice(const PIString & path, PIIODevice::DeviceMode mode): PIThread() {

50
libs/main/io_devices/piiodevice.h
View File

@@ -1,5 +1,5 @@
/*! \file piiodevice.h
* \brief Abstract input/output device
/*! @file piiodevice.h
* @brief Abstract input/output device
*/
/*
PIP - Platform Independent Primitives
@@ -35,10 +35,10 @@ typedef bool (*ReadRetFunc)(void * , uchar * , int );
#ifdef DOXYGEN
//! \relatesalso PIIODevice \brief Use this macro to enable automatic creation instances of your class with \a createFromFullPath() function
//! \relatesalso PIIODevice @brief Use this macro to enable automatic creation instances of your class with \a createFromFullPath() function
# define REGISTER_DEVICE(class)
//! \relatesalso PIIODevice \brief Use this macro instead of PIOBJECT when describe your own PIIODevice
//! \relatesalso PIIODevice @brief Use this macro instead of PIOBJECT when describe your own PIIODevice
# define PIIODEVICE(class)
#else
@@ -59,20 +59,20 @@ public:
//! Constructs a empty PIIODevice
explicit PIIODevice();
//! \brief Open modes for PIIODevice
//! @brief Open modes for PIIODevice
enum DeviceMode {
ReadOnly /*! Device can only read */ = 0x01,
WriteOnly /*! Device can only write */ = 0x02,
ReadWrite /*! Device can both read and write */ = 0x03
};
//! \brief Options for PIIODevice, works with some devices
//! @brief Options for PIIODevice, works with some devices
enum DeviceOption {
BlockingRead /*! \a read block until data is received, default off */ = 0x01,
BlockingWrite /*! \a write block until data is sent, default off */ = 0x02
};
//! \brief Characteristics of PIIODevice subclass
//! @brief Characteristics of PIIODevice subclass
enum DeviceInfoFlag {
Sequential /*! Continuous bytestream without datagrams */ = 0x01,
Reliable /*! Channel without data errors / corruptions */ = 0x02
@@ -144,7 +144,7 @@ public:
int reopenTimeout() {return property(PIStringAscii("reopenTimeout")).toInt();}
/** \brief Set "threaded read slot"
/** @brief Set "threaded read slot"
* \details Set external static function of threaded read that will be executed
* at every successful threaded read. Function should have format
* "bool func(void * data, uchar * readed, int size)" */
@@ -153,7 +153,7 @@ public:
//! Set custom data that will be passed to "threaded read slot"
void setThreadedReadData(void * d) {ret_data_ = d;}
/** \brief Set size of threaded read buffer
/** @brief Set size of threaded read buffer
* \details Default size is 4096 bytes. If your device can read at single read
* more than 4096 bytes you should use this function to adjust buffer size */
void setThreadedReadBufferSize(int new_size) {threaded_read_buffer_size = new_size; threadedReadBufferSizeChanged();}
@@ -240,12 +240,12 @@ public:
//! Configure device from PIVariantTypes::IODevice
void configureFromVariant(const PIVariantTypes::IODevice & d);
//! \brief Try to determine suitable device, create new one, configure it with \a configureFromFullPath() and returns it.
//! @brief Try to determine suitable device, create new one, configure it with \a configureFromFullPath() and returns it.
//! \details To function \a configureFromFullPath() "full_path" passed without \a fullPathPrefix() + "://".
//! See \ref PIIODevice_sec7
static PIIODevice * createFromFullPath(const PIString & full_path);
//! \brief Try to determine suitable device, create new one, configure it with \a configureFromVariant() and returns it.
//! @brief Try to determine suitable device, create new one, configure it with \a configureFromVariant() and returns it.
//! \details To function \a configureFromFullPath() "full_path" passed without \a fullPathPrefix() + "://".
//! See \ref PIIODevice_sec7
static PIIODevice * createFromVariant(const PIVariantTypes::IODevice & d);
@@ -276,57 +276,57 @@ public:
//! \{
//! \fn bool open()
//! \brief Open device
//! @brief Open device
//! \fn bool open(const PIString & path)
//! \brief Open device with path "path"
//! @brief Open device with path "path"
//! \fn bool open(const DeviceMode & mode)
//! \brief Open device with mode "mode"
//! @brief Open device with mode "mode"
//! \fn bool open(const PIString & path, const DeviceMode & mode)
//! \brief Open device with path "path" and mode "mode"
//! @brief Open device with path "path" and mode "mode"
//! \fn bool close()
//! \brief Close device
//! @brief Close device
//! \fn int write(PIByteArray data)
//! \brief Write "data" to device
//! @brief Write "data" to device
//! \}
//! \vhandlers
//! \{
//! \fn void flush()
//! \brief Immediate write all buffers
//! @brief Immediate write all buffers
//! \}
//! \events
//! \{
//! \fn void opened()
//! \brief Raise if succesfull open
//! @brief Raise if succesfull open
//! \fn void closed()
//! \brief Raise if succesfull close
//! @brief Raise if succesfull close
//! \fn void threadedReadEvent(uchar * readed, int size)
//! \brief Raise if read thread succesfull read some data
//! @brief Raise if read thread succesfull read some data
//! \fn void threadedWriteEvent(ullong id, int written_size)
//! \brief Raise if write thread successfull write some data of task with ID "id"
//! @brief Raise if write thread successfull write some data of task with ID "id"
//! \}
//! \ioparams
//! \{
#ifdef DOXYGEN
//! \brief setReopenEnabled, default "true"
//! @brief setReopenEnabled, default "true"
bool reopenEnabled;
//! \brief setReopenTimeout in ms, default 1000
//! @brief setReopenTimeout in ms, default 1000
int reopenTimeout;
//! \brief setThreadedReadBufferSize in bytes, default 4096
//! @brief setThreadedReadBufferSize in bytes, default 4096
int threadedReadBufferSize;
#endif
//! \}

2
libs/main/io_devices/piiostring.cpp
View File

@@ -21,7 +21,7 @@
/*! \class PIIOString
* \brief PIIODevice wrapper around PIString
* @brief PIIODevice wrapper around PIString
*
* \section PIIOString_sec0 Synopsis
* This class allow you to use PIString as PIIODevice and pass it to, e.g. PIConfig

4
libs/main/io_devices/piiostring.h
View File

@@ -1,5 +1,5 @@
/*! \file piiostring.h
* \brief PIIODevice wrapper around PIString
/*! @file piiostring.h
* @brief PIIODevice wrapper around PIString
*/
/*
PIP - Platform Independent Primitives

4
libs/main/io_devices/pipeer.h
View File

@@ -1,5 +1,5 @@
/*! \file pipeer.h
* \brief Peering net node
/*! @file pipeer.h
* @brief Peering net node
*/
/*
PIP - Platform Independent Primitives

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

44
libs/main/io_devices/piserial.h
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,
@@ -71,26 +71,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;
};
@@ -180,42 +180,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
//! \}

2
libs/main/io_devices/pisharedmemory.cpp
View File

@@ -41,7 +41,7 @@
/*! \class PISharedMemory
* \brief Shared memory
* @brief Shared memory
*
* \section PISharedMemory_sec0 Synopsis
* This class provide access to local file. You can manipulate

4
libs/main/io_devices/pisharedmemory.h
View File

@@ -1,5 +1,5 @@
/*! \file pisharedmemory.h
* \brief Shared memory
/*! @file pisharedmemory.h
* @brief Shared memory
*/
/*
PIP - Platform Independent Primitives

6
libs/main/io_devices/pispi.h
View File

@@ -1,5 +1,5 @@
/*! \file pispi.h
* \brief SPI device
/*! @file pispi.h
* @brief SPI device
*/
/*
PIP - Platform Independent Primitives
@@ -33,7 +33,7 @@ public:
explicit PISPI(const PIString & path = PIString(), uint speed_hz = 1000000, PIIODevice::DeviceMode mode = PIIODevice::ReadWrite);
virtual ~PISPI();
//! \brief Parameters of PISPI
//! @brief Parameters of PISPI
enum Parameters {
ClockInverse /*! SPI clk polarity control*/ = 0x1,
ClockPhaseShift /*! SPI clk phase control */ = 0x2,

2
libs/main/io_devices/pitransparentdevice.cpp
View File

@@ -21,7 +21,7 @@
/*! \class PITransparentDevice
* \brief PIIODevice that pass write to read
* @brief PIIODevice that pass write to read
*
* \section PITransparentDevice_sec0 Synopsis
* This class pass all data from \a write() function to \a read().

4
libs/main/io_devices/pitransparentdevice.h
View File

@@ -1,5 +1,5 @@
/*! \file pitransparentdevice.h
* \brief PIIODevice that pass write to read
/*! @file pitransparentdevice.h
* @brief PIIODevice that pass write to read
*/
/*
PIP - Platform Independent Primitives

4
libs/main/io_devices/piusb.h
View File

@@ -1,5 +1,5 @@
/*! \file piusb.h
* \brief USB device
/*! @file piusb.h
* @brief USB device
*/
/*
PIP - Platform Independent Primitives