From 54c813f821e5e33b3df9a4a7ffde07f31aa7d5d5 Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Tue, 10 Jul 2018 17:50:13 +0200
Subject: [PATCH] fix documentation
---
alib2std/src/extensions/array.hpp | 2 ++
alib2std/src/extensions/bitset.hpp | 2 ++
alib2std/src/extensions/deque.hpp | 2 ++
alib2std/src/extensions/forward_list.hpp | 2 ++
alib2std/src/extensions/forward_tree.hpp | 2 ++
alib2std/src/extensions/linear_set.hpp | 2 ++
alib2std/src/extensions/list.hpp | 2 ++
alib2std/src/extensions/map.hpp | 2 ++
alib2std/src/extensions/pair.hpp | 2 ++
alib2std/src/extensions/ptr_array.hpp | 10 +++++++++-
10 files changed, 27 insertions(+), 1 deletion(-)
diff --git a/alib2std/src/extensions/array.hpp b/alib2std/src/extensions/array.hpp
index e8af083731..60026a8634 100644
--- a/alib2std/src/extensions/array.hpp
+++ b/alib2std/src/extensions/array.hpp
@@ -213,6 +213,8 @@ struct compare < ext::array < T, N > > {
*
* \tparam T the type of values inside the array
* \tparam N the size of the array
+ *
+ * \return string representation
*/
template< class T, std::size_t N >
std::string to_string ( const ext::array < T, N > & value ) {
diff --git a/alib2std/src/extensions/bitset.hpp b/alib2std/src/extensions/bitset.hpp
index 5ccd53e233..54ce942108 100644
--- a/alib2std/src/extensions/bitset.hpp
+++ b/alib2std/src/extensions/bitset.hpp
@@ -136,6 +136,8 @@ struct compare < ext::bitset < N > > {
* \param value the bitset to be converted to string
*
* \tparam N the size of the bitset
+ *
+ * \return string representation
*/
template < size_t N >
std::string to_string ( const ext::bitset < N > & value ) {
diff --git a/alib2std/src/extensions/deque.hpp b/alib2std/src/extensions/deque.hpp
index 6e6f3daae9..bef002eb3b 100644
--- a/alib2std/src/extensions/deque.hpp
+++ b/alib2std/src/extensions/deque.hpp
@@ -213,6 +213,8 @@ struct compare < ext::deque < T, Ts ... > > {
*
* \tparam T the type of values inside the deque
* \tparam Ts ... remaining unimportant template parameters of the deque
+ *
+ * \return string representation
*/
template < class T, class ... Ts >
std::string to_string ( const ext::deque < T, Ts ... > & value ) {
diff --git a/alib2std/src/extensions/forward_list.hpp b/alib2std/src/extensions/forward_list.hpp
index 5a06c33f4b..e56e9ef6cf 100644
--- a/alib2std/src/extensions/forward_list.hpp
+++ b/alib2std/src/extensions/forward_list.hpp
@@ -146,6 +146,8 @@ struct compare<ext::forward_list<T, Ts ... >> {
*
* \tparam T the type of values inside the forward_list
* \tparam Ts ... remaining unimportant template parameters of the forward_list
+ *
+ * \return string representation
*/
template < class T, class ... Ts >
std::string to_string ( const ext::forward_list < T, Ts ... > & value ) {
diff --git a/alib2std/src/extensions/forward_tree.hpp b/alib2std/src/extensions/forward_tree.hpp
index 2c81a6971f..7487e4efd5 100644
--- a/alib2std/src/extensions/forward_tree.hpp
+++ b/alib2std/src/extensions/forward_tree.hpp
@@ -1237,6 +1237,8 @@ struct compare < ext::forward_tree < T > > {
* \param value the forward_tree to be converted to string
*
* \tparam T the type of values inside the forward_tree
+ *
+ * \return string representation
*/
template < class T >
std::string to_string ( const ext::forward_tree < T > & value ) {
diff --git a/alib2std/src/extensions/linear_set.hpp b/alib2std/src/extensions/linear_set.hpp
index 2fabe018c0..53e5f0b484 100644
--- a/alib2std/src/extensions/linear_set.hpp
+++ b/alib2std/src/extensions/linear_set.hpp
@@ -877,6 +877,8 @@ struct compare<ext::linear_set<T, Ts ...>> {
*
* \tparam T the type of values inside the set
* \tparam Ts ... remaining unimportant template parameters of the set
+ *
+ * \return string representation
*/
template < class T, class ... Ts >
std::string to_string ( const ext::linear_set < T, Ts ... > & value ) {
diff --git a/alib2std/src/extensions/list.hpp b/alib2std/src/extensions/list.hpp
index 8f6840bead..01f751367f 100644
--- a/alib2std/src/extensions/list.hpp
+++ b/alib2std/src/extensions/list.hpp
@@ -206,6 +206,8 @@ struct compare < ext::list < T, Ts ... > > {
*
* \tparam T the type of values inside the list
* \tparam Ts ... remaining unimportant template parameters of the list
+ *
+ * \return string representation
*/
template < class T, class ... Ts >
std::string to_string ( const ext::list < T, Ts ... > & value ) {
diff --git a/alib2std/src/extensions/map.hpp b/alib2std/src/extensions/map.hpp
index a6075e384e..e5a92756fa 100644
--- a/alib2std/src/extensions/map.hpp
+++ b/alib2std/src/extensions/map.hpp
@@ -304,6 +304,8 @@ struct compare < ext::map < T, R, Ts ... > > {
*
* \tparam T the type of values inside the map
* \tparam Ts ... remaining unimportant template parameters of the map
+ *
+ * \return string representation
*/
template < class T, class R, class ... Ts >
std::string to_string ( const ext::map < T, R, Ts ... > & value ) {
diff --git a/alib2std/src/extensions/pair.hpp b/alib2std/src/extensions/pair.hpp
index a43fca6c58..929d5ff90f 100644
--- a/alib2std/src/extensions/pair.hpp
+++ b/alib2std/src/extensions/pair.hpp
@@ -136,6 +136,8 @@ struct compare < ext::pair < T, R > > {
*
* \tparam T the type of the first value inside the pair
* \tparam R the type of the second value inside the pair
+ *
+ * \return string representation
*/
template < class T, class R >
std::string to_string ( const ext::pair < T, R > & value ) {
diff --git a/alib2std/src/extensions/ptr_array.hpp b/alib2std/src/extensions/ptr_array.hpp
index b32e3de76f..55bedddfe7 100644
--- a/alib2std/src/extensions/ptr_array.hpp
+++ b/alib2std/src/extensions/ptr_array.hpp
@@ -37,7 +37,7 @@ namespace ext {
/**
* \brief
- * Implementation of array storing synamicaly allocated instances of given type. The class mimicks the iterface of the standard library array, but effectively allowing polymorphic objects to be stored inside.
+ * Implementation of array storing dynamicaly allocated instances of given type. The class mimicks the iterface of the standard library array, but effectively allows polymorphic objects to be stored inside.
*
* \tparam T the type of stored values
* \tparam N the size of the array
@@ -582,6 +582,8 @@ namespace std {
* \tparam Type the type of stored values
* \tparam N the size of the array
*
+ * \param tpl the accessed tuple
+ *
* \return reference to value on given index
*/
template < std::size_t I, class Type, std::size_t N >
@@ -597,6 +599,8 @@ auto & get ( ext::ptr_array < Type, N > & tpl ) {
* \tparam Type the type of stored values
* \tparam N the size of the array
*
+ * \param tpl the accessed tuple
+ *
* \return reference to value on given index
*/
template < std::size_t I, class Type, std::size_t N >
@@ -612,6 +616,8 @@ const auto & get ( const ext::ptr_array < Type, N > & tpl ) {
* \tparam Type the type of stored values
* \tparam N the size of the array
*
+ * \param tpl the accessed tuple
+ *
* \return reference to value on given index
*/
template < std::size_t I, class Type, std::size_t N >
@@ -683,6 +689,8 @@ struct compare < ext::ptr_array < T, N > > {
*
* \tparam T the type of values inside the array
* \tparam N the size of the array
+ *
+ * \return string representation
*/
template < class T, std::size_t N >
std::string to_string ( const ext::ptr_array < T, N > & value ) {
--
GitLab