From: fluffymormegil <mpread@chiark.greenend.org.uk>
Date: Sat, 23 Oct 2010 23:47:44 +0000 (+0100)
Subject: Adjusted manpage for libmormegil::abs
X-Git-Tag: v1.0.0~3^2~4
X-Git-Url: http://git.blackswordsonics.com/?a=commitdiff_plain;h=ef91b70de9b68c40df88c38e31908264e2fced3c;p=libmormegil

Adjusted manpage for libmormegil::abs
---

diff --git a/man/libmormegil::abs.3 b/man/libmormegil::abs.3
index 379b8e8..cd29f81 100644
--- a/man/libmormegil::abs.3
+++ b/man/libmormegil::abs.3
@@ -2,9 +2,9 @@
 .SH NAME
 libmormegil::abs \- compute absolute value
 .SH SYNOPSIS
-#include <libmormegil/abs.hh>
+#include <libmormegil/mathops.hh>
 
-template<typename T> T abs(const T& i) { i < T(0) ? -i : i; }
+template<typename T> T libmormegil::abs(const T& i);
 
 .SH DESCRIPTION
 .I libmormegil::abs
@@ -13,13 +13,18 @@ written for libmormegil because the C++ standard library provides only
 floating point (via <cmath> / <math.h>) or complex (via <complex>)
 implementations of this function.
 
+.SH RETURNS
+
+The absolute value (magnitude) of \fIi\fP.
+
 .SH CAVEATS
 
-Implemented as naively as possible.
+Implemented as naively as possible. Breaks horribly if type T has exotic
+behaviour for its lessthan or unary minus operators.
 
 .SH AUTHOR
 Martin Read <mpread@chiark.greenend.org.uk>
 
 .SH SEE ALSO
 
-libmormegil(3), libmormegil::S20prng(3)
+libmormegil(3)