Skip to content

Commit 58aa664

Browse files
committed
Add documentation
1 parent 6a0d654 commit 58aa664

File tree

1 file changed

+37
-1
lines changed
  • src/xtd.core/include/xtd/collections/generic/helpers

1 file changed

+37
-1
lines changed

src/xtd.core/include/xtd/collections/generic/helpers/iterator.hpp

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,56 @@ namespace xtd {
1515
/// @brief The xtd::collections::generic::helpers namespace contains helpers for generic collections, sush as comparer, equator an hasher structs.
1616
namespace helpers {
1717
/// @brief Represents the value iterator type.
18+
/// @par Header
19+
/// ```cpp
20+
/// #include <xtd/collections/generic/helpers/iterator>
21+
/// ```
22+
/// @par Namespace
23+
/// xtd::collections::generic::helpers
24+
/// @par Library
25+
/// xtd.core
26+
/// @ingroup xtd_core helpers_generic_collections
1827
template <class input_iterator_t>
1928
using iterator_value_t = typename std::iterator_traits<input_iterator_t>::value_type;
2029

2130
/// @brief Represents the key iterator type.
31+
/// @par Header
32+
/// ```cpp
33+
/// #include <xtd/collections/generic/helpers/iterator>
34+
/// ```
35+
/// @par Namespace
36+
/// xtd::collections::generic::helpers
37+
/// @par Library
38+
/// xtd.core
39+
/// @ingroup xtd_core helpers_generic_collections
2240
template <class input_iterator_t>
2341
using iterator_key_t = std::remove_const_t<std::tuple_element_t<0, iterator_value_t<input_iterator_t>>>;
2442

2543
/// @brief Represents the mapped iterator type.
44+
/// @par Header
45+
/// ```cpp
46+
/// #include <xtd/collections/generic/helpers/iterator>
47+
/// ```
48+
/// @par Namespace
49+
/// xtd::collections::generic::helpers
50+
/// @par Library
51+
/// xtd.core
52+
/// @ingroup xtd_core helpers_generic_collections
2653
template <class input_iterator_t>
2754
using iterator_mapped_t = std::tuple_element_t<1, iterator_value_t<input_iterator_t>>;
2855

2956
/// @brief Represents the iterator to allocator type.
57+
/// @par Header
58+
/// ```cpp
59+
/// #include <xtd/collections/generic/helpers/iterator>
60+
/// ```
61+
/// @par Namespace
62+
/// xtd::collections::generic::helpers
63+
/// @par Library
64+
/// xtd.core
65+
/// @ingroup xtd_core helpers_generic_collections
3066
template< class input_iterator_t >
31-
using iterator_to_allocator_t = std::pair<std::add_const_t<std::tuple_element_t<0, iterator_value_t<input_iterator_t>>>, std::tuple_element_t<1, iterator_value_t<input_iterator_t>>>;
67+
using iterator_to_allocator_t = std::pair<std::add_const_t<iterator_key_t<input_iterator_t>>, iterator_mapped_t<input_iterator_t>>;
3268
}
3369
}
3470
}

0 commit comments

Comments
 (0)