rename doc macros

This commit is contained in:
2021-08-04 16:31:32 +03:00
parent 0c7ce272e6
commit 25def958a1
140 changed files with 963 additions and 983 deletions

View File

@@ -1,5 +1,5 @@
/*! \file picollection.h
* \brief Custom elements collection
/*! @file picollection.h
* @brief Custom elements collection
*/
/*
PIP - Platform Independent Primitives
@@ -27,7 +27,7 @@
#ifdef DOXYGEN
/** \brief Add existing element "object" in group with name "group"
/** @brief Add existing element "object" in group with name "group"
* \relatesalso PICollection
* \details If there is no group with name "group" it will be created.
* Only one element of the class "object" can be in group "group". If
@@ -35,7 +35,7 @@
* be pointer to object based on PIObject. */
# define ADD_TO_COLLECTION(group, object)
/** \brief Add new element of class "class" in group with name "group"
/** @brief Add new element of class "class" in group with name "group"
* \relatesalso PICollection
* \details If there is no group with name "group" it will be created.
* Only one element of the class "class" can be in group "group". If
@@ -65,10 +65,10 @@ class PIP_EXPORT PICollection
public:
PICollection() {;}
//! \brief Returns all existing groups by their names
//! @brief Returns all existing groups by their names
static PIStringList groups();
//! \brief Returns all elements of group "group"
//! @brief Returns all elements of group "group"
static PIVector<const PIObject * > groupElements(const PIString & group);
static bool addToGroup(const PIString & group, const PIObject * element);