git-svn-id: svn://db.shs.com.ru/pip@636 12ceb7fc-bf1f-11e4-8940-5bc7170c53b5

src_io_utils/piethutilbase.cpp

@@ -22,6 +22,29 @@
 #  include "picrypt.h"
 #endif
 
+/** \class PIEthUtilBase
+ * \brief Base class for ethernet utils
+ *
+ * \section PIEthUtilBase_synopsis Synopsis
+ * %PIEthUtilBase provides crypt layer for derived classes:
+ * \a PIStreamPacker and \a PIBroadcast. All input and output
+ * (sended and received) data can be decrypted/encrypted by this layer.
+ *
+ * By default crypt layer is disabled.
+ *
+ * You can separetely enable it and set ready-to-use
+ * key by \a setCryptEnabled() and \a setCryptKey(). Or you can
+ * use \a createCryptKey() to generate key from your passphrase
+ * and automatic enable crypt layer.
+ *
+ * \note To use crypt layer, PIP should be built with crypt module,
+ * otherwise your in/out data will be lost.
+ *
+ * You can use this class as base for your own classes. Use \a cryptData()
+ * and \a decryptData() when send and receive your data.
+ *
+*/
+
 
 PIEthUtilBase::PIEthUtilBase() {
 	_crypt = false;