summaryrefslogtreecommitdiffstats
path: root/sigcore
diff options
context:
space:
mode:
authorBen Boeckel <MathStuf@gmail.com>2008-12-25 01:14:39 -0500
committerBen Boeckel <MathStuf@gmail.com>2008-12-25 01:14:39 -0500
commitf99b528691a6965574d6f8ba570a6442f7d8cee8 (patch)
tree077f1c3f3c2932c2383de80284082d29826aeef1 /sigcore
parent53770889160c56d85745b96b066b611d147bf81f (diff)
downloadsigen-f99b528691a6965574d6f8ba570a6442f7d8cee8.tar.gz
sigen-f99b528691a6965574d6f8ba570a6442f7d8cee8.tar.xz
sigen-f99b528691a6965574d6f8ba570a6442f7d8cee8.zip
Documented Range::in parameters
Diffstat (limited to 'sigcore')
-rw-r--r--sigcore/Range.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/sigcore/Range.h b/sigcore/Range.h
index 7fd03602..d3dea3a5 100644
--- a/sigcore/Range.h
+++ b/sigcore/Range.h
@@ -93,10 +93,14 @@ class SIGCORE_EXPORT Range
bool valid() const;
/**
+ * \param value The value to check for.
+ *
* \return \p true if the range contains \p value, \p false otherwise.
*/
bool in(const double value) const;
/**
+ * \param range The range to check for.
+ *
* \return \p true if \p range is completely within the range, \p false otherwise.
*/
bool in(const Range& range) const;