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

doxygen @ tags replaced to \

Browse Source
This commit is contained in:
Пелипенко Иван
2022-03-14 21:19:31 +03:00
parent 9bf1a11701
commit 54b5372356
142 changed files with 1079 additions and 1079 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,5 @@
/*! @file pipropertystorage.h
* @brief Storage of properties for GUI usage
/*! \file pipropertystorage.h
* \brief Storage of properties for GUI usage
*
* This file declare PIPropertyStorage
*/
@@ -28,7 +28,7 @@
#include "pivariant.h"
/**
* @brief Key-value storage, based on PIVector with PIPropertyStorage::Property elements. Each element in vector
* \brief Key-value storage, based on PIVector with PIPropertyStorage::Property elements. Each element in vector
* contains unique name and you can identify property by name with propertyValueByName(), propertyByName().
* You can add property using addProperty(const Property&), addProperty(const PIString&, const PIVariant&, const PIString&, int).
*/
@@ -37,7 +37,7 @@ public:
PIPropertyStorage() {}
/**
* @brief PIPropertyStorage element.
* \brief PIPropertyStorage element.
*/
struct PIP_EXPORT Property {
Property(const PIString & n = PIString(), const PIString & c = PIString(), const PIVariant & v = PIVariant(), int f = 0):
@@ -112,18 +112,18 @@ public:
const PIPropertyStorage & propertyStorage() const {return *this;}
/**
* @brief Check if property with \a name exists
* \brief Check if property with \a name exists
* @return "true" if property exists
*/
bool isPropertyExists(const PIString & _name) const;
/**
* @brief Remove all properties
* \brief Remove all properties
*/
void clearProperties() {props.clear();}
/**
* @brief Add property if name isn't present in storage, otherwrise update existing property with same name.
* \brief Add property if name isn't present in storage, otherwrise update existing property with same name.
* @return "true" if new property added, else if update existing property return "false"
* @param p to copy in storage
*/
@@ -131,32 +131,32 @@ public:
bool addProperty(Property && p);
/**
* @brief First of all construct Property with method params. After then add property if name isn't present
* \brief First of all construct Property with method params. After then add property if name isn't present
* in storage, otherwrise update existing property with same name.
* @return "true" if new property added, else if update existing property return "false"
*/
bool addProperty(const PIString & _name, const PIVariant & _def_value, const PIString & _comment = PIString(), int _flags = 0);
/**
* @brief Remove property with \a name
* \brief Remove property with \a name
* @return "true" if property exists and removed
*/
bool removeProperty(const PIString & _name);
/**
* @brief Remove properties wich has \a flag set
* \brief Remove properties wich has \a flag set
* @return removed properties count
*/
int removePropertiesByFlag(int flag);
/**
* @brief Merge other \a properties_ into this
* \brief Merge other \a properties_ into this
* @param flag_ignore - properties wich has this flag set will be ignored in merge
*/
void updateProperties(const PIVector<Property> & properties_, int flag_ignore = 0);
/**
* @brief Search property by name and return it.
* \brief Search property by name and return it.
*
* @param name of property
* @return property value or default constructed Property
@@ -164,7 +164,7 @@ public:
Property propertyByName(const PIString & name) const;
/**
* @brief Search property by name and return property value.
* \brief Search property by name and return property value.
*
* @param name of property
* @return property value or invalid PIVariant if name unknown
@@ -172,7 +172,7 @@ public:
PIVariant propertyValueByName(const PIString & name) const;
/**
* @brief Set value of property with specific name if name is present in storage.
* \brief Set value of property with specific name if name is present in storage.
*
* @param name of property to set value
* @param value to set
@@ -181,7 +181,7 @@ public:
bool setPropertyValue(const PIString & name, const PIVariant & value);
/**
* @brief Set comment of property with specific name if name is present in storage.
* \brief Set comment of property with specific name if name is present in storage.
*
* @param name of property to set comment
* @param comment to set
@@ -190,7 +190,7 @@ public:
bool setPropertyComment(const PIString & name, const PIString & comment);
/**
* @brief Set flags of property with specific name if name is present in storage.
* \brief Set flags of property with specific name if name is present in storage.
*
* @param name of property to set flags
* @param flags to set