Diff: Utilities/Segment.hpp

Revision:

7:471901a04573

Parent:

6:a8c83a2e6fa4

--- a/Utilities/Segment.hpp	Wed Jan 23 13:11:04 2019 -0600
+++ b/Utilities/Segment.hpp	Mon Mar 04 08:10:00 2019 -0600
@@ -39,8 +39,9 @@
 
 namespace MaximInterface {
 
+/// @brief
 /// Advances a given iterator by a given number of elements with bounds checking.
-/// InputIt must meet the requirements of InputIterator.
+/// @tparam InputIt Must meet the requirements of InputIterator.
 /// @param[in,out] it Iterator to advance. 
 /// @param bound
 /// Past-the-end boundary iterator. If distance is positive, bound must be
@@ -97,14 +98,17 @@
   return distance;
 }
 
-/// Locates an iterator sub-range using segment number addressing. Useful for
-/// devices that divide the memory space into uniform chunks such as pages and
-/// segments. ForwardIt must meet the requirements of ForwardIterator.
+/// @brief Locates an iterator sub-range using segment number addressing.
+/// @details
+/// Useful for devices that divide the memory space into uniform chunks such as
+/// pages and segments.
+/// @tparam ForwardIt Must meet the requirements of ForwardIterator.
 /// @param begin Beginning of the input data range.
 /// @param end End of the input data range.
 /// @param segmentSize Number of elements contained in a segment.
 /// @param segmentNum Zero-indexed number of the desired segment.
-/// @returns Pair of iterators representing the sub-range of the segment within
+/// @returns
+/// Pair of iterators representing the sub-range of the segment within
 /// the input range. If the segment does not exist within the input range, both
 /// iterators in the pair are set to the end iterator of the input range.
 template <typename ForwardIt, typename Index>