add small documentation for for_first_then_each

6 years ago · f4b7a4f302
parent b4217ce9f2
commit f4b7a4f302
1 changed files with 5 additions and 0 deletions
--- a/src/util/LoopUtil.h
+++ b/src/util/LoopUtil.h
@ -13,6 +13,11 @@

 #include <iterator>

+/**
+ *	for_first_then_each
+ *	loop over the container from begin to end but handles the first element
+ *	differently.
+ */
 template <typename Container, typename Function_first, typename Function_others>
 void for_first_then_each(Container container, Function_first function_first, Function_others function_others)
 {