[mlpack-git] master: Add more documentation for RangeSearchRules. (c86275b)

[gitdub at mlpack.org]

Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/ef51b032f275266f781d42b9bd0aa50aa26a3077...8522b04c3d9a82fb7e964bafd72e70f0cd30bf4b

>---------------------------------------------------------------

commit c86275b4c7e5af0d69d3b504f9341785e163c443
Author: MarcosPividori <marcos.pividori at gmail.com>
Date:   Fri Jul 22 02:03:09 2016 -0300

    Add more documentation for RangeSearchRules.


>---------------------------------------------------------------

c86275b4c7e5af0d69d3b504f9341785e163c443
 src/mlpack/methods/range_search/range_search_rules.hpp | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/mlpack/methods/range_search/range_search_rules.hpp b/src/mlpack/methods/range_search/range_search_rules.hpp
index e392ee4..0f492a8 100644
--- a/src/mlpack/methods/range_search/range_search_rules.hpp
+++ b/src/mlpack/methods/range_search/range_search_rules.hpp
@@ -13,6 +13,13 @@ namespace mlpack {
 namespace range {
 
 
+/**
+ * The RangeSearchRules class is a template helper class used by RangeSearch
+ * class when performing range searches.
+ *
+ * @tparam MetricType The metric to use for computation.
+ * @tparam TreeType The tree type to use; must adhere to the TreeType API.
+ */
 template<typename MetricType, typename TreeType>
 class RangeSearchRules
 {