Skip to content

Commit 48139b1

Browse files
committed
Doc comments
1 parent 5a47891 commit 48139b1

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

provides/include/dumpster_v1/synopsis.hpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,18 @@ namespace dumpster_v1 {
66

77
// finally.hpp =================================================================
88

9+
/// Finalizer that invokes stored action when destroyed.
910
template <class Action> struct finally_t;
1011

12+
/// Creates a finalizer that invokes the action when destroyed.
1113
template <class Action>
1214
finally_t<std::remove_cvref_t<Action>> finally(Action &&action);
1315

1416
// insertion_sort.hpp ==========================================================
1517

18+
/// Sorts given sentinel terminated sequence to ascending order. Intended for
19+
/// use cases where sequences are expected to be short, and low overhead and
20+
/// small code size are desired.
1621
template <class RandomIt, class Less, class IsSentinel>
1722
void insertion_sort(RandomIt values, Less less, IsSentinel is_sentinel);
1823

0 commit comments

Comments
 (0)