doxygen @ tags replaced to \
This commit is contained in:
@@ -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
|
||||
//! \}
|
||||
|
||||
Reference in New Issue
Block a user