Просмотр исходного кода

common/algorithm: Add description comment indicating intended algorithms

Makes it explicit that the header is intended for iterator-based
algorithms that can ideally operate on any type.
Lioncash 6 лет назад
Родитель
Сommit
d5706346d7
1 измененных файлов с 5 добавлено и 0 удалено
  1. 5 0
      src/common/algorithm.h

+ 5 - 0
src/common/algorithm.h

@@ -7,6 +7,11 @@
 #include <algorithm>
 #include <functional>
 
+// Algorithms that operate on iterators, much like the <algorithm> header.
+//
+// Note: If the algorithm is not general-purpose and/or doesn't operate on iterators,
+//       it should probably not be placed within this header.
+
 namespace Common {
 
 template <class ForwardIt, class T, class Compare = std::less<>>