more ai generated doc with human review

libs/main/io_utils/piethutilbase.h

@@ -29,45 +29,61 @@
 #include "pibytearray.h"
 #include "pip_io_utils_export.h"
 
+
+//! \~english Base class for ethernet utils
+//! \~russian Базовый класс для утилит ethernet
 class PIP_IO_UTILS_EXPORT PIEthUtilBase {
 public:
+	//! \~english Constructs PIEthUtilBase
+	//! \~russian Создает PIEthUtilBase
 	PIEthUtilBase();
+
+	//! \~english Destructor
+	//! \~russian Деструктор
 	~PIEthUtilBase();
 
-	//! Set crypt layer enabled
+	//! \~english Set crypt layer enabled
+	//! \~russian Включить слой шифрования
 	void setCryptEnabled(bool on);
 
-	//! Enable crypt layer
+	//! \~english Enable crypt layer
+	//! \~russian Включить слой шифрования
 	void cryptEnable();
 
-	//! Disable crypt layer
+	//! \~english Disable crypt layer
+	//! \~russian Выключить слой шифрования
 	void cryptDisable();
 
-	//! Returns if crypt layer enabled
+	//! \~english Returns if crypt layer enabled
+	//! \~russian Возвращает, включен ли слой шифрования
 	bool isCryptEnabled() const;
 
 
-	//! Set crypt layer key to \"k\"
+	//! \~english Set crypt layer key to "k"
+	//! \~russian Установить ключ шифрования в "k"
 	void setCryptKey(const PIByteArray & k);
 
-	//! Generate crypt layer key by \a PICrypt::hash and
-	//! set crypt layer enabled
+	//! \~english Generate crypt layer key by \a PICrypt::hash and set crypt layer enabled
+	//! \~russian Сгенерировать ключ шифрования с помощью \a PICrypt::hash и включить шифрование
 	void createCryptKey(const PIString & k);
 
-	//! Returns crypt layer key
+	//! \~english Returns crypt layer key
+	//! \~russian Возвращает ключ шифрования
 	PIByteArray cryptKey() const;
 
-	//! \brief Returns addition size for crypted data.
+	//! \~english Returns addition size for crypted data
+	//! \~russian Возвращает дополнительный размер для зашифрованных данных
 	static size_t cryptSizeAddition();
 
 protected:
-	/*! \brief Returns encrypted data if layer enabled,
-	 *  otherwise returns unchanged \"data\" */
+	//! \~english Returns encrypted data if layer enabled, otherwise returns unchanged "data"
+	//! \~russian Возвращает зашифрованные данные, если слой включен, иначе возвращает неизмененные "data"
 	PIByteArray cryptData(const PIByteArray & data);
 
-	/*! \brief Returns decrypted data if layer enabled,
-	 *  otherwise returns unchanged \"data\". If decryption
-	 *  was unsuccessfull returns empty %PIByteArray. */
+	//! \~english Returns decrypted data if layer enabled, otherwise returns unchanged "data". If decryption was unsuccessful returns empty
+	//! %PIByteArray
+	//! \~russian Возвращает расшифрованные данные, если слой включен, иначе возвращает неизмененные "data". Если расшифровка неуспешна,
+	//! возвращает пустой %PIByteArray
 	PIByteArray decryptData(const PIByteArray & data);
 
 private: