From 535fb79fe2b05dd2d564786d0f9d9c6bdc76e8dc Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Tue, 19 Jun 2018 15:48:48 +0200
Subject: [PATCH] add documentation for template parameters of container
classes
---
alib2common/src/container/ObjectsDeque.h | 2 ++
alib2common/src/container/ObjectsList.h | 2 ++
alib2common/src/container/ObjectsMap.h | 3 +++
alib2common/src/container/ObjectsPair.h | 3 +++
alib2common/src/container/ObjectsSet.h | 2 ++
alib2common/src/container/ObjectsTree.h | 2 ++
alib2common/src/container/ObjectsTrie.h | 3 +++
alib2common/src/container/ObjectsVector.h | 2 ++
8 files changed, 19 insertions(+)
diff --git a/alib2common/src/container/ObjectsDeque.h b/alib2common/src/container/ObjectsDeque.h
index 051afee6c9..889e37d7a7 100644
--- a/alib2common/src/container/ObjectsDeque.h
+++ b/alib2common/src/container/ObjectsDeque.h
@@ -42,6 +42,8 @@ namespace container {
* Represents an adaptor of a deque container from the stl extensions provided by the algorithms library.
*
* The deque is a linear random access container.
+ *
+ * \tparam ElementType the type of values stored in the container.
*/
template < class ElementType = object::Object >
class ObjectsDeque final : public ext::deque < ElementType >, public ContainerBase {
diff --git a/alib2common/src/container/ObjectsList.h b/alib2common/src/container/ObjectsList.h
index 5d3ea6e4b1..858adeaf5e 100644
--- a/alib2common/src/container/ObjectsList.h
+++ b/alib2common/src/container/ObjectsList.h
@@ -42,6 +42,8 @@ namespace container {
* Represents an adaptor of a list container from the stl extensions provided by the algorithms library.
*
* The list is a linear sequential container.
+ *
+ * \tparam ElementType the type of values stored in the container.
*/
template < class ElementType = object::Object >
class ObjectsList final : public ext::list < ElementType >, public ContainerBase {
diff --git a/alib2common/src/container/ObjectsMap.h b/alib2common/src/container/ObjectsMap.h
index 93958bbdf2..d73956baea 100644
--- a/alib2common/src/container/ObjectsMap.h
+++ b/alib2common/src/container/ObjectsMap.h
@@ -43,6 +43,9 @@ namespace container {
* Represents an adaptor of a map container from the stl extensions provided by the algorithms library.
*
* The map is an associative container.
+ *
+ * \tparam KeyType the type of keys in the map.
+ * \tparam ValueType the type of values in the map.
*/
template < class KeyType = object::Object, class ValueType = object::Object >
class ObjectsMap final : public ext::map < KeyType, ValueType >, public ContainerBase {
diff --git a/alib2common/src/container/ObjectsPair.h b/alib2common/src/container/ObjectsPair.h
index 604182d9a2..4f8683175d 100644
--- a/alib2common/src/container/ObjectsPair.h
+++ b/alib2common/src/container/ObjectsPair.h
@@ -42,6 +42,9 @@ namespace container {
* Represents an adaptor of a pair datatype from the stl extensions provided by the algorithms library.
*
* The datatype packs two arbitrary values together.
+ *
+ * \tparam FirstType the type of the first object in the pair.
+ * \tparam SecondType the type of the second object in the pair.
*/
template < class FirstType = object::Object, class SecondType = object::Object >
class ObjectsPair final : public ext::pair < FirstType, SecondType >, public ContainerBase {
diff --git a/alib2common/src/container/ObjectsSet.h b/alib2common/src/container/ObjectsSet.h
index b0218b8e28..3233477ca0 100644
--- a/alib2common/src/container/ObjectsSet.h
+++ b/alib2common/src/container/ObjectsSet.h
@@ -42,6 +42,8 @@ namespace container {
* Represents an adaptor of a set container from the stl extensions provided by the algorithms library.
*
* The set is an associative container.
+ *
+ * \tparam ElementType the type of values stored in the container.
*/
template < class ElementType = object::Object >
class ObjectsSet final : public ext::set < ElementType >, public ContainerBase {
diff --git a/alib2common/src/container/ObjectsTree.h b/alib2common/src/container/ObjectsTree.h
index da848a374b..323a70a9ee 100644
--- a/alib2common/src/container/ObjectsTree.h
+++ b/alib2common/src/container/ObjectsTree.h
@@ -42,6 +42,8 @@ namespace container {
* Represents an adaptor of a tree container from the stl extensions provided by the algorithms library.
*
* The tree is a structured random access container.
+ *
+ * \tparam ElementType the type of values in the tree nodes.
*/
template < class ElementType = object::Object >
class ObjectsTree final : public ext::tree < ElementType >, public ContainerBase {
diff --git a/alib2common/src/container/ObjectsTrie.h b/alib2common/src/container/ObjectsTrie.h
index c5e2042144..e097533ae6 100644
--- a/alib2common/src/container/ObjectsTrie.h
+++ b/alib2common/src/container/ObjectsTrie.h
@@ -42,6 +42,9 @@ namespace container {
* Represents an adaptor of a trie container from the stl extensions provided by the algorithms library.
*
* The trie is an structured associative container.
+ *
+ * \tparam KeyType the type of keys to access subnodes of a trie node.
+ * \tparam ValueType the type of values in the trie nodes.
*/
template < class KeyType = object::Object, class ValueType = object::Object >
class ObjectsTrie final : public ext::trie < KeyType, ValueType >, public ContainerBase {
diff --git a/alib2common/src/container/ObjectsVector.h b/alib2common/src/container/ObjectsVector.h
index 19ef17696a..7cd4cfe202 100644
--- a/alib2common/src/container/ObjectsVector.h
+++ b/alib2common/src/container/ObjectsVector.h
@@ -42,6 +42,8 @@ namespace container {
* Represents an adaptor of a vector container from the stl extensions provided by the algorithms library.
*
* The vector is a linear random access container.
+ *
+ * \tparam ElementType the type of values stored in the container.
*/
template < class ElementType = object::Object >
class ObjectsVector final : public ext::vector < ElementType >, public ContainerBase {
--
GitLab