rename doc macros

libs/main/io_utils/pibasetransfer.h

@@ -1,5 +1,5 @@
-/*! \file pibasetransfer.h
- * \brief Base class for reliable send and receive data in fixed packets with error correction, pause and resume
+/*! @file pibasetransfer.h
+ * @brief Base class for reliable send and receive data in fixed packets with error correction, pause and resume
 */
 /*
 	PIP - Platform Independent Primitives

libs/main/io_utils/pibroadcast.h

@@ -1,5 +1,5 @@
-/*! \file pibroadcast.h
- * \brief Broadcast for all interfaces, including loopback
+/*! @file pibroadcast.h
+ * @brief Broadcast for all interfaces, including loopback
 */
 /*
 	PIP - Platform Independent Primitives
@@ -117,7 +117,7 @@ public:
 	//! \{
 
 		//! \fn void receiveEvent(PIByteArray data)
-		//! \brief Raise on packet received
+		//! @brief Raise on packet received
 
 	//! \}
 

libs/main/io_utils/piconnection.cpp

@@ -21,7 +21,7 @@
 #include "piconfig.h"
 
 /** \class PIConnection
- * \brief Complex Input/Output point
+ * @brief Complex Input/Output point
  * 
  * \section PIConnection_synopsis Synopsis
  * %PIConnection provides abstract layer over physical devices,

libs/main/io_utils/piconnection.h

@@ -1,5 +1,5 @@
-/*! \file piconnection.h
- * \brief Complex I/O point
+/*! @file piconnection.h
+ * @brief Complex I/O point
 */
 /*
 	PIP - Platform Independent Primitives
@@ -43,11 +43,11 @@ public:
 
 	~PIConnection();
 	
-	/*! \brief Configure connection from config file "config" from section "name". Returns if configuration was successful
+	/*! @brief Configure connection from config file "config" from section "name". Returns if configuration was successful
 	 * \details \b Warning: all devices, filters and channels removed before configure! */
 	bool configureFromConfig(const PIString & config, const PIString & name = PIStringAscii("connection"));
 	
-	/*! \brief Configure connection from config content "string" from section "name". Returns if configuration was successful
+	/*! @brief Configure connection from config content "string" from section "name". Returns if configuration was successful
 	 * \details \b Warning: all devices, filters and channels removed before configure! */
 	bool configureFromString(PIString * string, const PIString & name = PIStringAscii("connection"));
 	
@@ -55,7 +55,7 @@ public:
 	PIString makeConfig() const;
 	
 	
-	/*! \brief Add device with full path "full_path", open mode "mode" to Device pool and connection
+	/*! @brief Add device with full path "full_path", open mode "mode" to Device pool and connection
 	 * \details Returns pointer to device or null if device can not be created. If "start" is true,
 	 * read thread is started immediately. Else, you can start read thread with functions \a startThreadedRead()
 	 * or \a startAllThreadedReads(). By default, read thread doesn`t start */
@@ -65,12 +65,12 @@ public:
 	
 	PIStringList deviceNames(const PIIODevice * dev) const;
 	
-	/*! \brief Remove device with full path "full_path" from connection
+	/*! @brief Remove device with full path "full_path" from connection
 	 * \details Returns if device was removed. If there is no connection bounded to this device,
 	 * it will be removed from Device pool */
 	bool removeDevice(const PIString & full_path);
 	
-	/*! \brief Remove all device from connection
+	/*! @brief Remove all device from connection
 	 * \details If there is no connection bounded to there devices, they removed from Device pool */
 	void removeAllDevices();
 	
@@ -83,7 +83,7 @@ public:
 	//! Returns all devices bounded to this connection
 	PIVector<PIIODevice * > boundedDevices() const;
 	
-	/*! \brief Add filter with name "name" to device with full path "full_path_name" or filter "full_path_name"
+	/*! @brief Add filter with name "name" to device with full path "full_path_name" or filter "full_path_name"
 	 * \details If there is no filter with name "name", connection create new with split mode "mode" and bound
 	 * to it device "full_path_name" or filter "full_path_name". If filter with name "name" already exists,
 	 * device "full_path_name" or filter "full_path_name" add to this filter.
@@ -100,7 +100,7 @@ public:
 	//! Add filter with "filter" to device "dev"
 	PIPacketExtractor * addFilter(PIPacketExtractor * filter, const PIIODevice * dev) {return addFilter(filter, devFPath(dev));}
 	
-	/*! \brief Remove from filter with name "name" device with full path "full_path_name" or filter "full_path_name"
+	/*! @brief Remove from filter with name "name" device with full path "full_path_name" or filter "full_path_name"
 	 * \details If there is no devices bounded to this filter, it will be removed. Returns if device was removed */
 	bool removeFilter(const PIString & name, const PIString & full_path_name);
 	
@@ -125,7 +125,7 @@ public:
 	//! Returns all devices bounded to filter "name"
 	PIVector<PIIODevice * > filterBoundedDevices(const PIString & name) const;
 	
-	/*! \brief Add to connection channel from "name_from" to "name_to"
+	/*! @brief Add to connection channel from "name_from" to "name_to"
 	 * \details "name_from" and "name_to" can be full pathes of devices or device names or filter names.
 	 * Returns \b false if there if no such device or filter, else create channel and returns \b true */
 	bool addChannel(const PIString & name_from, const PIString & name_to);
@@ -139,7 +139,7 @@ public:
 	//! Add to connection channel from "dev_from" to "dev_to"
 	bool addChannel(const PIIODevice * dev_from, const PIIODevice * dev_to) {return addChannel(devFPath(dev_from), devFPath(dev_to));}
 	
-	/*! \brief Remove from connection channel from "name_from" to "name_to"
+	/*! @brief Remove from connection channel from "name_from" to "name_to"
 	 * \details "name_from" and "name_to" can be full pathes of devices or filter names.
 	 * Returns \b false if there if no such device or filter, else remove channel and returns \b true */
 	bool removeChannel(const PIString & name_from, const PIString & name_to);
@@ -153,7 +153,7 @@ public:
 	//! Remove from connection channel from "dev_from" to "dev_to"
 	bool removeChannel(const PIIODevice * dev_from, const PIIODevice * dev_to) {return removeChannel(devFPath(dev_from), devFPath(dev_to));}
 	
-	/*! \brief Remove from connection all channels from "name_from"
+	/*! @brief Remove from connection all channels from "name_from"
 	 * \details "name_from" can be full path of device or filter name.
 	 * Returns \b false if there if no such device or filter, else remove channels and returns \b true */
 	bool removeChannel(const PIString & name_from);
@@ -167,7 +167,7 @@ public:
 	//! Returns all channels of this connection as full pathes or filter names pair array (from, to)
 	PIVector<PIPair<PIString, PIString> > channels() const;
 	
-	/*! \brief Add to connection sender with name "name" device with full path "full_path"
+	/*! @brief Add to connection sender with name "name" device with full path "full_path"
 	 * \details If there is no sender with name "name", connection create new, bound
 	 * to it device "full_path_name" and start sender timer with frequency "frequency".
 	 * If sender with name "name" already exists, device "full_path_name" add to this sender
@@ -179,7 +179,7 @@ public:
 	//! Add to connection sender with name "name" device "dev"
 	void addSender(const PIString & name, const PIIODevice * dev, float frequency, bool start = false) {addSender(name, devFPath(dev), frequency, start);}
 	
-	/*! \brief Remove from sender with name "name" device with full path "full_path_name"
+	/*! @brief Remove from sender with name "name" device with full path "full_path_name"
 	 * \details If there is no devices bounded to this sender, it will be removed. Returns if sender was removed */
 	bool removeSender(const PIString & name, const PIString & full_path_name);
 	
@@ -321,13 +321,13 @@ public:
 //! \{
 	
 	//! \fn void dataReceivedEvent(const PIString & from, const PIByteArray & data)
-	//! \brief Raise on data received from device with full path "from"
+	//! @brief Raise on data received from device with full path "from"
 	
 	//! \fn void packetReceivedEvent(const PIString & from, const PIByteArray & data)
-	//! \brief Raise on packet received from filter with name "from"
+	//! @brief Raise on packet received from filter with name "from"
 	
 	//! \fn void qualityChanged(const PIIODevice * device, PIDiagnostics::Quality new_quality, PIDiagnostics::Quality old_quality)
-	//! \brief Raise on diagnostic quality of device "device" changed from "old_quality" to "new_quality"
+	//! @brief Raise on diagnostic quality of device "device" changed from "old_quality" to "new_quality"
 	
 //! \}
 	

libs/main/io_utils/pidatatransfer.h

@@ -1,5 +1,5 @@
-/*! \file pidatatransfer.h
- * \brief Class for send and receive PIByteArray via \a PIBaseTransfer
+/*! @file pidatatransfer.h
+ * @brief Class for send and receive PIByteArray via \a PIBaseTransfer
 */
 /*
 	PIP - Platform Independent Primitives

libs/main/io_utils/pidiagnostics.cpp

@@ -21,7 +21,7 @@
 
 
 /** \class PIDiagnostics
- * \brief Connection quality diagnostics
+ * @brief Connection quality diagnostics
  * \details
  * \section PIDiagnostics_sec0 Synopsis
  * This class provide abstract connection quality diagnostics and

libs/main/io_utils/pidiagnostics.h

@@ -1,5 +1,5 @@
-/*! \file pidiagnostics.h
- * \brief Connection quality diagnostics
+/*! @file pidiagnostics.h
+ * @brief Connection quality diagnostics
 */
 /*
 	PIP - Platform Independent Primitives
@@ -102,23 +102,23 @@ public:
 //! \{
 	
 	//! \fn void start(double msecs = 1000.)
-	//! \brief Start diagnostics evaluations with period "msecs" milliseconds
+	//! @brief Start diagnostics evaluations with period "msecs" milliseconds
 	
 	//! \fn void reset()
-	//! \brief Reset diagnostics counters
+	//! @brief Reset diagnostics counters
 	
 	//! \fn void received(int size, bool correct = true)
-	//! \brief Notify diagnostics about "correct" corected received packet
+	//! @brief Notify diagnostics about "correct" corected received packet
 	
 	//! \fn void sended(int size)
-	//! \brief Notify diagnostics about sended packet
+	//! @brief Notify diagnostics about sended packet
 	
 //! \}
 //! \events
 //! \{
 
 	//! \fn void qualityChanged(PIDiagnostics::Quality new_quality, PIDiagnostics::Quality old_quality)
-	//! \brief Raise on change receive quality from "old_quality" to "new_quality"
+	//! @brief Raise on change receive quality from "old_quality" to "new_quality"
 
 //! \}
 	

libs/main/io_utils/piethutilbase.h

@@ -1,5 +1,5 @@
-/*! \file piethutilbase.h
- * \brief Base class for ethernet utils
+/*! @file piethutilbase.h
+ * @brief Base class for ethernet utils
 */
 /*
 	PIP - Platform Independent Primitives
@@ -56,11 +56,11 @@ public:
 
 protected:
 
-	/*! \brief Returns encrypted data if layer enabled,
+	/*! @brief Returns encrypted data if layer enabled,
 	 *  otherwise returns unchanged \"data\" */
 	PIByteArray   cryptData(const PIByteArray & data);
 
-	/*! \brief Returns decrypted data if layer enabled,
+	/*! @brief Returns decrypted data if layer enabled,
 	 *  otherwise returns unchanged \"data\". If decryption
 	 *  was unsuccessfull returns empty %PIByteArray. */
 	PIByteArray decryptData(const PIByteArray & data);

libs/main/io_utils/pifiletransfer.h

@@ -1,5 +1,5 @@
-/*! \file pifiletransfer.h
- * \brief Class for send and receive files and directories via \a PIBaseTransfer
+/*! @file pifiletransfer.h
+ * @brief Class for send and receive files and directories via \a PIBaseTransfer
 */
 /*
 	PIP - Platform Independent Primitives

libs/main/io_utils/pipacketextractor.cpp

@@ -21,7 +21,7 @@
 
 
 /** \class PIPacketExtractor
- * \brief Packets extractor
+ * @brief Packets extractor
  * \details
  * \section PIPacketExtractor_main Synopsis
  * This class implements packet recognition by various algorithms and custom

libs/main/io_utils/pipacketextractor.h

@@ -1,5 +1,5 @@
-/*! \file pipacketextractor.h
- * \brief Packets extractor
+/*! @file pipacketextractor.h
+ * @brief Packets extractor
 */
 /*
 	PIP - Platform Independent Primitives
@@ -130,27 +130,27 @@ public:
 //! \{
 
 	//! \fn void packetReceived(uchar * data, int size)
-	//! \brief Raise on successfull \a packetValidate() function
+	//! @brief Raise on successfull \a packetValidate() function
 
 //! \}
 
 protected:
 
-	/** \brief Function to validate header
+	/** @brief Function to validate header
 	 * \param src Your header content
 	 * \param rec Received header
 	 * \param size Header size
 	 * \details Default implementation returns by-byte "src" with "rec" compare result */
 	virtual bool validateHeader(uchar * src, uchar * rec, int size) {if (ret_func_header != 0) return ret_func_header(ret_data_, src, rec, size); for (int i = 0; i < size; ++i) if (src[i] != rec[i]) return false; return true;}
 
-	/** \brief Function to validate footer
+	/** @brief Function to validate footer
 	 * \param src Your footer content
 	 * \param rec Received footer
 	 * \param size Footer size
 	 * \details Default implementation returns by-byte "src" with "rec" compare result */
 	virtual bool validateFooter(uchar * src, uchar * rec, int size) {if (ret_func_footer != 0) return ret_func_footer(ret_data_, src, rec, size); for (int i = 0; i < size; ++i) if (src[i] != rec[i]) return false; return true;}
 
-	/** \brief Function to validate payload
+	/** @brief Function to validate payload
 	 * \param rec Received payload
 	 * \param size payload size
 	 * \details Default implementation returns \b true */

libs/main/io_utils/piparsehelper.h

@@ -1,5 +1,5 @@
-/*! \file piparsehelper.h
- * \brief Helper class to automate structs receive
+/*! @file piparsehelper.h
+ * @brief Helper class to automate structs receive
 */
 /*
 	PIP - Platform Independent Primitives
@@ -28,7 +28,7 @@
 
 
 /** \class PIParseHelper
- * \brief Helper class to automate structs receive
+ * @brief Helper class to automate structs receive
  *
  *
  * \section PIParseHelper_synopsis Synopsis
@@ -85,11 +85,11 @@ template <typename Key>
 class PIParseHelper {
 public:
 
-	//! \brief Construct %PIParseHelper with target object \"p\"
+	//! @brief Construct %PIParseHelper with target object \"p\"
 	PIParseHelper(PIObject * p): parent(p) {}
 
 
-	//! \brief Assign key \"key\" to event handler \"handler\" with 1 argument
+	//! @brief Assign key \"key\" to event handler \"handler\" with 1 argument
 	template <typename T, typename Ret>
 	void assign(Key key, Ret(*handler)(void*,T)) {
 		if (!parent) return;
@@ -110,7 +110,7 @@ public:
 	}
 
 
-	//! \brief Assign key \"key\" to event handler \"handler\" without arguments
+	//! @brief Assign key \"key\" to event handler \"handler\" without arguments
 	template <typename Ret>
 	void assign(Key key, Ret(*handler)(void*)) {
 		if (!parent) return;
@@ -130,7 +130,7 @@ public:
 	}
 
 
-	//! \brief Assign key \"key\" to lambda-function \"func\" with 1 argument
+	//! @brief Assign key \"key\" to lambda-function \"func\" with 1 argument
 	//! \note Important! Direct lambda functions are not allowed, see \ref PIParseHelper_lambda
 	template <typename T>
 	void assign(Key key, std::function<void(T)> func) {
@@ -145,7 +145,7 @@ public:
 	}
 
 
-	//! \brief Assign key \"key\" to lambda-function \"func\" without arguments
+	//! @brief Assign key \"key\" to lambda-function \"func\" without arguments
 	//! \note Important! Direct lambda functions are not allowed, see \ref PIParseHelper_lambda
 	void assign(Key key, std::function<void()> func) {
 		if (!parent) return;
@@ -156,7 +156,7 @@ public:
 	}
 
 
-	//! \brief Deserialize data and invoke assigned to \"key\" methods
+	//! @brief Deserialize data and invoke assigned to \"key\" methods
 	void parse(Key key, PIByteArray ba) {
 		if (!parent) return;
 		auto fl = functions.value(key);

libs/main/io_utils/pistreampacker.h

@@ -1,5 +1,5 @@
-/*! \file pistreampacker.h
- * \brief Simple packet wrap aroud any PIIODevice
+/*! @file pistreampacker.h
+ * @brief Simple packet wrap aroud any PIIODevice
 */
 /*
 	PIP - Platform Independent Primitives
@@ -110,7 +110,7 @@ public:
 	//! \{
 
 		//! \fn void received(uchar * readed, int size)
-		//! \brief Handler to receive data. \a PIIODevice::threadedReadEvent()
+		//! @brief Handler to receive data. \a PIIODevice::threadedReadEvent()
 		//! can be connected to this handler
 
 	//! \}
@@ -119,10 +119,10 @@ public:
 	//! \{
 
 		//! \fn void packetReceiveEvent(PIByteArray data)
-		//! \brief Raise on packet successfully received
+		//! @brief Raise on packet successfully received
 
 		//! \fn void sendRequest(PIByteArray data)
-		//! \brief Raise from \a send() function. This data should
+		//! @brief Raise from \a send() function. This data should
 		//! be directly sended to your device. You can
 		//! connect this event to \a PIIODevice::write() handler