SHS/pip
4
3
Fork 0
Code Issues 67 Pull Requests 1 Actions Releases Wiki Activity

doc ru

Browse Source
This commit is contained in:
Пелипенко Иван
2022-05-05 22:31:59 +03:00
parent d1f7065c8a
commit 0b3ee4bb6a
38 changed files with 378 additions and 211 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
libs/main/core/pibytearray.cpp
View File

@@ -21,14 +21,7 @@
#include "pistringlist.h"
#include <iostream>
//! \addtogroup Core
//! \{
//! \class PIByteArray pibytearray.h
//!
//! \~\brief
//! \~english The %PIByteArray class provides an array of bytes
//! \~russian Класс %PIByteArray представляет собой массив байтов
//!
//! \~\details
//! \~english
//! %PIByteArray used to store raw bytes.
@@ -98,7 +91,6 @@
//! метов \a append().
//! \~\snippet pibytearray.cpp 3
//!
//! \}
static const uchar base64Table[64] = {

4
libs/main/core/pibytearray.h
View File

@@ -36,6 +36,10 @@ class PIString;
class PIByteArray;
//! \ingroup Core
//! \~\brief
//! \~english The %PIByteArray class provides an array of bytes.
//! \~russian Класс %PIByteArray представляет собой массив байтов.
class PIP_EXPORT PIByteArray: public PIDeque<uchar>
{
public:

8
libs/main/core/pichar.cpp
View File

@@ -36,14 +36,7 @@ char * __utf8name__ = 0;
#endif
#include <wchar.h>
//! \addtogroup Core
//! \{
//! \class PIChar pichar.h
//!
//! \~\brief
//! \~english %PIChar represents a single character
//! \~russian %PIChar представляет собой один символ строки
//!
//! \~\details
//! \~english
//! This class is wrapper around UTF16.
@@ -53,7 +46,6 @@ char * __utf8name__ = 0;
//! %PIChar хранит один сивол в UTF16. Имеет много контрукторов, геттеров в различные
//! кодировки (системную, консольную, UTF8) и информационных функций.
//!
//! \}
ushort charFromCodepage(const char * c, int size, const char * codepage, int * taken = 0) {

4
libs/main/core/pichar.h
View File

@@ -32,6 +32,10 @@ extern PIP_EXPORT char * __syslocname__;
extern PIP_EXPORT char * __sysoemname__;
extern PIP_EXPORT char * __utf8name__;
//! \ingroup Core
//! \~\brief
//! \~english %PIChar represents a single character.
//! \~russian %PIChar представляет собой один символ строки.
class PIP_EXPORT PIChar
{
friend class PIString;

8
libs/main/core/pichunkstream.cpp
View File

@@ -19,13 +19,8 @@
#include "pichunkstream.h"
//! \addtogroup Core
//! \{
//! \class PIChunkStream pichunkstream.h
//! \brief
//! \~english Class for binary de/serialization
//! \~russian Класс для бинарной де/сериализации
//!
//! \details
//! \~english \section PIChunkStream_sec0 Synopsis
//! \~russian \section PIChunkStream_sec0 Краткий обзор
//! \~english
@@ -89,7 +84,6 @@
//! \~russian ... и десериализовать:
//! \~\snippet pichunkstream.cpp read_new
//!
//! \}
void PIChunkStream::setSource(const PIByteArray & data) {

4
libs/main/core/pichunkstream.h
View File

@@ -29,6 +29,10 @@
#include "pibytearray.h"
//! \ingroup Core
//! \~\brief
//! \~english Class for binary de/serialization.
//! \~russian Класс для бинарной де/сериализации.
class PIP_EXPORT PIChunkStream
{
public:

8
libs/main/core/picli.cpp
View File

@@ -21,13 +21,8 @@
#include "pisysteminfo.h"
//! \addtogroup Core
//! \{
//! \class PICLI picli.h
//! \~\brief
//! \~english Command-Line parser
//! \~russian Парсер командной строки
//!
//! \details
//! \~english \section PICLI_sec0 Synopsis
//! \~russian \section PICLI_sec0 Краткий обзор
//! \~english
@@ -66,7 +61,6 @@
//! a.out --debug -c --value 10
//! \endcode
//!
//! \}
PICLI::PICLI(int argc, char * argv[]) {

4
libs/main/core/picli.h
View File

@@ -28,6 +28,10 @@
#include "piobject.h"
//! \ingroup Core
//! \~\brief
//! \~english Command-Line parser.
//! \~russian Парсер командной строки.
class PIP_EXPORT PICLI: public PIObject
{
PIOBJECT_SUBCLASS(PICLI, PIObject)

7
libs/main/core/picollection.cpp
View File

@@ -20,13 +20,7 @@
#include "picollection.h"
//! \addtogroup Core
//! \{
//! \~\class PICollection picollection.h
//! \~\brief
//! \~english Helper to collect and retrieve classes to groups
//! \~russian Помощник для создания и получения классов в группы
//!
//! \~\details
//! \~english \section PICollection_sec0 Synopsis
//! \~russian \section PICollection_sec0 Краткий обзор
@@ -41,7 +35,6 @@
//! объектов в глобальные группы. Затем можно получить их список в любом месте программы.
//! \~\snippet picollection.cpp main
//!
//! \}
PIStringList PICollection::groups() {

4
libs/main/core/picollection.h
View File

@@ -100,6 +100,10 @@
#endif
//! \ingroup Core
//! \~\brief
//! \~english Helper to collect and retrieve classes to groups.
//! \~russian Помощник для создания и получения классов в группы.
class PIP_EXPORT PICollection
{
friend class __PICollectionInitializer;

3
libs/main/core/piconstchars.cpp
View File

@@ -20,8 +20,6 @@
#include "pistring.h"
//! \addtogroup Core
//! \{
//! \~\class PIConstChars piconstchars.h
//! \~\details
//! \~english \section PICout_sec0 Synopsis
@@ -42,7 +40,6 @@
//!
//! Используется для более удобной работы с обычными C-строками.
//!
//! \}
bool PIConstChars::startsWith(const PIConstChars & str) const {

4
libs/main/core/piconstchars.h
View File

@@ -31,8 +31,8 @@
//! \ingroup Core
//! \~\brief
//! \~english C-String class
//! \~russian Класс C-строки
//! \~english C-String class.
//! \~russian Класс C-строки.
class PIP_EXPORT PIConstChars {
public:

8
libs/main/core/picout.cpp
View File

@@ -34,13 +34,8 @@
#endif
//! \addtogroup Core
//! \{
//! \~\class PICout picout.h
//! \~\brief
//! \~english Universal output to console class
//! \~russian Универсальный вывод в консоль
//!
//! \~\details
//! \~english \section PICout_sec0 Synopsis
//! \~russian \section PICout_sec0 Краткий обзор
//! \~english
@@ -79,7 +74,6 @@
//! \~russian \section PICout_ex1 Создание своего оператора вывода
//! \~\snippet picout.cpp own
//!
//! \}
//! \addtogroup Core

4
libs/main/core/picout.h
View File

@@ -125,6 +125,10 @@ namespace PICoutManipulators {
//! \ingroup Core
//! \~\brief
//! \~english Universal output to console class.
//! \~russian Универсальный вывод в консоль.
class PIP_EXPORT PICout {
public:

10
libs/main/core/pidatetime.cpp
View File

@@ -35,20 +35,12 @@
//! \addtogroup Core
//! \{
//!
//! \~\class PITime pidatetime.h
//! \brief
//! \~english Calendar time
//! \~russian Календарное время
//!
//! \~\class PIDate pidatetime.h
//! \brief
//! \~english Calendar date
//! \~russian Календарная дата
//!
//! \~\class PIDateTime pidatetime.h
//! \brief
//! \~english Calendar date and time
//! \~russian Календарное дата и время
//!
//! \}

12
libs/main/core/pidatetime.h
View File

@@ -30,6 +30,10 @@
#include "pisystemtime.h"
//! \ingroup Core
//! \~\brief
//! \~english Calendar time.
//! \~russian Календарное время.
class PIP_EXPORT PITime {
public:
//! \~english Construct %PITime from hours, minutes, seconds and milliseconds
@@ -102,6 +106,10 @@ PIP_EXPORT PICout operator <<(PICout s, const PITime & v);
//! \ingroup Core
//! \~\brief
//! \~english Calendar date.
//! \~russian Календарная дата.
class PIP_EXPORT PIDate {
public:
//! \~english Construct %PIDate from year, month and day
@@ -162,6 +170,10 @@ PIP_EXPORT PICout operator <<(PICout s, const PIDate & v);
//! \ingroup Core
//! \~\brief
//! \~english Calendar date and time.
//! \~russian Календарное дата и время.
class PIP_EXPORT PIDateTime {
public:
//! \~english Construct null %PIDateTime

16
libs/main/core/piobject.cpp
View File

@@ -26,13 +26,7 @@
#endif
//! \addtogroup Core
//! \{
//! \~\class PIObject piobject.h
//! \~\brief
//! \~english This is base class for any classes which use events -> handlers mechanism
//! \~russian Этот класс является базовым для использования механизма события -> обработчики
//!
//! \~\details
//! \~english \section PIObject_sec0 Events and Event handlers
//! \~russian \section PIObject_sec0 События и Обработчики событий
@@ -98,16 +92,12 @@
//! handler A: event to event
//! event to lambda
//! \endcode
//! \}
//!
//! \addtogroup Core
//! \{
//! \~\class PIObject::Connection piobject.h
//! \~\brief
//! \~english Helper class for obtain info about if connection successful and disconnect single connection
//! \~russian Вспомогательный класс для получения информации об успешности соединения и возможности его разрыва
//! \}
//! \~\details
//!
PIObject::__MetaFunc::__MetaFunc() {

8
libs/main/core/piobject.h
View File

@@ -36,6 +36,10 @@
typedef void (*Handler)(void * );
//! \ingroup Core
//! \~\brief
//! \~english This is base class for any classes which use events -> handlers mechanism.
//! \~russian Этот класс является базовым для использования механизма события -> обработчики.
class PIP_EXPORT PIObject {
#ifndef MICRO_PIP
friend class PIObjectManager;
@@ -53,6 +57,10 @@ public:
virtual ~PIObject();
//! \ingroup Core
//! \~\brief
//! \~english Helper class for obtain info about if connection successful and disconnect single connection.
//! \~russian Вспомогательный класс для получения информации об успешности соединения и возможности его разрыва.
class PIP_EXPORT Connection {
friend class PIObject;
Connection(void * sl, void * si, const PIString & e = PIString(),

31
libs/main/core/pipropertystorage.cpp
View File

@@ -20,13 +20,7 @@
#include "pipropertystorage.h"
//! \addtogroup Core
//! \{
//! \~\class PIPropertyStorage pipropertystorage.h
//! \~\brief
//! \~english This class provides key-value properties storage
//! \~russian Этот класс предоставляет ключ-значение хранение свойств
//!
//! \~\details
//! \~english \section PIPropertyStorage_sec0 Synopsis
//! \~russian \section PIPropertyStorage_sec0 Краткий обзор
@@ -45,35 +39,12 @@
//! \~russian Пример:
//! \~\code{.cpp}
//! \endcode
//! \}
//!
//! \addtogroup Core
//! \{
//! \~\class PIPropertyStorage::Property pipropertystorage.h
//! \~\brief
//! \~english PIPropertyStorage element
//! \~russian Элемент PIPropertyStorage
//!
//! \~\details
//! \~english \section PIPropertyStorage_sec1 Synopsis
//! \~russian \section PIPropertyStorage_sec1 Краткий обзор
//!
//! \~english
//! Key-value storage, based on PIVector with PIPropertyStorage::Property elements. Each element in vector
//! contains unique name. You can access property by name with \a propertyValueByName() or \a propertyByName().
//! You can add or replace property by \a addProperty(const Property&) or \a addProperty(const PIString&, const PIVariant&, const PIString&, int).
//!
//! \~russian
//! Хранилище свойств ключ-значние, основанный на PIVector с элементами PIPropertyStorage::Property.
//! Каждый элемент имеет уникальное имя. Доступ к свойствам через \a propertyValueByName() или \a propertyByName().
//! Добавление и перезапись свойств через \a addProperty(const Property&) или \a addProperty(const PIString&, const PIVariant&, const PIString&, int).
//!
//! \~english Example:
//! \~russian Пример:
//! \~\code{.cpp}
//! \endcode
//! \}
bool PIPropertyStorage::isPropertyExists(const PIString & _name) const {

8
libs/main/core/pipropertystorage.h
View File

@@ -29,6 +29,10 @@
#include "pivariant.h"
//! \ingroup Core
//! \~\brief
//! \~english This class provides key-value properties storage.
//! \~russian Этот класс предоставляет ключ-значение хранение свойств.
class PIP_EXPORT PIPropertyStorage {
public:
@@ -36,6 +40,10 @@ public:
//! \~russian Создает пустой %PIPropertyStorage
PIPropertyStorage() {}
//! \ingroup Core
//! \~\brief
//! \~english PIPropertyStorage element.
//! \~russian Элемент PIPropertyStorage.
struct PIP_EXPORT Property {
//! \~english Contructs %PIPropertyStorage::Property with name "n", comment "c", value "v" and flags "f"

7
libs/main/core/pistring.cpp
View File

@@ -31,13 +31,7 @@
#include <locale>
#include <codecvt>
//! \addtogroup Core
//! \{
//! \class PIString pistring.h
//! \brief
//! \~english String class
//! \~russian Класс строки
//!
//! \~\details
//! \~english \section PIString_sec0 Synopsis
//! \~russian \section PIString_sec0 Краткий обзор
@@ -54,7 +48,6 @@
//! создана из множества типов и преобразована в несколько типов.
//! Имеет множество методов для манипуляций.
//!
//! \}

4
libs/main/core/pistring.h
View File

@@ -34,6 +34,10 @@
class PIStringList;
//! \ingroup Core
//! \~\brief
//! \~english String class.
//! \~russian Класс строки.
class PIP_EXPORT PIString
{
friend PIByteArray & operator >>(PIByteArray & s, PIString & v);

7
libs/main/core/pistringlist.cpp
View File

@@ -20,16 +20,9 @@
#include "pistringlist.h"
//! \addtogroup Core
//! \{
//! \~\class PIStringList pistringlist.h
//! \~\brief
//! \~english Based on \a PIDeque<PIString> strings list
//! \~russian Основанный на \a PIDeque<PIString> массив строк
//!
//! \~\details
//!
//! \}
//! \details

4
libs/main/core/pistringlist.h
View File

@@ -29,6 +29,10 @@
#include "pistring.h"
//! \ingroup Core
//! \~\brief
//! \~english Based on \a PIDeque<PIString> strings list.
//! \~russian Основанный на \a PIDeque<PIString> массив строк.
class PIP_EXPORT PIStringList: public PIDeque<PIString>
{
public:

16
libs/main/core/pisystemtime.cpp
View File

@@ -45,13 +45,8 @@
#endif
//! \addtogroup Core
//! \{
//! \class PISystemTime pisystemtime.h
//! \brief
//! \~english System time with nanosecond precision
//! \~russian Системное время с точностью до наносекунд
//!
//! \details
//! \~english \section PISystemTime_sec0 Synopsis
//! \~russian \section PISystemTime_sec0 Краткий обзор
//! \~english
@@ -72,16 +67,10 @@
//! \~russian \section PISystemTime_sec1 Пример
//! \~\snippet pitimer.cpp system_time
//!
//! \}
//! \addtogroup Core
//! \{
//! \class PITimeMeasurer pisystemtime.h
//! \brief
//! \~english Time measurements
//! \~russian Измерение времени
//!
//! \details
//! \~english \section PITimeMeasurer_sec0 Usage
//! \~russian \section PITimeMeasurer_sec0 Использование
//! \~english
@@ -96,7 +85,6 @@
//! Эти методы возвращают нано, микро, милли и секунды с приставками
//! "n", "u", "m" и "s".
//!
//! \}

8
libs/main/core/pisystemtime.h
View File

@@ -30,6 +30,10 @@
#include "pistring.h"
//! \ingroup Core
//! \~\brief
//! \~english System time with nanosecond precision.
//! \~russian Системное время с точностью до наносекунд.
class PIP_EXPORT PISystemTime {
public:
@@ -187,6 +191,10 @@ inline PICout operator <<(PICout s, const PISystemTime & v) {s.space(); s.setCon
//! \ingroup Core
//! \~\brief
//! \~english Time measurements.
//! \~russian Измерение времени.
class PIP_EXPORT PITimeMeasurer {
public:
PITimeMeasurer();

1
libs/main/core/pivariant.cpp
View File

@@ -21,7 +21,6 @@
/** \class PIVariant
* \brief Variant type
* \details
* \section PIVariant_sec0 Synopsis
* This class provides general type that can contains all standard types, some

3
libs/main/core/pivariant.h
View File

@@ -201,6 +201,9 @@ classname_to __PIVariantFunctions__<classname_from>::castVariant<classname_to>(c
#endif
//! \ingroup Core
//! \~\brief
//! \~english Variant type.
class PIP_EXPORT PIVariant {
friend PICout operator <<(PICout s, const PIVariant & v);
friend PIByteArray & operator <<(PIByteArray & s, const PIVariant & v);