better API comment

Co-Authored-By: Julian Oes <julian@oes.ch>
This commit is contained in:
Julian Kent
2019-09-05 10:12:45 +02:00
committed by Matthias Grob
parent 31450c407c
commit 4a4309327a
+1 -1
View File
@@ -26,7 +26,7 @@ bool is_finite(Type x) {
* @param x input possibly outside of the range
* @param low lower limit of the allowed range
* @param high upper limit of the allowed range
* @return wrapped value inside the range
* @return wrapped value inside the range, or NAN if value is too far away from range.
*/
template<typename Type>
Type wrap(Type x, Type low, Type high) {