[mlpack-git] master: Update documentation. (7b433e5)

[gitdub at big.cc.gt.atl.ga.us]

Repository : https://github.com/mlpack/mlpack

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/f8ceffae0613b350f4d6bdd46c6c8633a40b4897...6ee21879488fe98612a4619b17f8b51e8da5215b

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

commit 7b433e521b87728e0eb530f8b21cf98421ada1fc
Author: ryan <ryan at ratml.org>
Date:   Fri Jul 24 14:31:53 2015 -0400

    Update documentation.


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

7b433e521b87728e0eb530f8b21cf98421ada1fc
 src/mlpack/methods/emst/dtb.hpp                        | 9 ++++-----
 src/mlpack/methods/neighbor_search/neighbor_search.hpp | 5 ++++-
 2 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/src/mlpack/methods/emst/dtb.hpp b/src/mlpack/methods/emst/dtb.hpp
index f706b13..898e586 100644
--- a/src/mlpack/methods/emst/dtb.hpp
+++ b/src/mlpack/methods/emst/dtb.hpp
@@ -63,11 +63,10 @@ namespace emst /** Euclidean Minimum Spanning Trees. */ {
  * More advanced usage of the class can use different types of trees, pass in an
  * already-built tree, or compute the MST using the O(n^2) naive algorithm.
  *
- * @tparam MetricType The metric to use.  IMPORTANT: this hasn't really been
- * tested with anything other than the L2 metric, so user beware. Note that the
- * tree type needs to compute bounds using the same metric as the type
- * specified here.
- * @tparam TreeType Type of tree to use.  Should use DTBStat as a statistic.
+ * @tparam MetricType The metric to use.
+ * @tparam MatType The type of data matrix to use.
+ * @tparam TreeType Type of tree to use.  This should follow the TreeType policy
+ *      API.
  */
 template<
     typename MetricType = metric::EuclideanDistance,
diff --git a/src/mlpack/methods/neighbor_search/neighbor_search.hpp b/src/mlpack/methods/neighbor_search/neighbor_search.hpp
index af3cf3d..758a154 100644
--- a/src/mlpack/methods/neighbor_search/neighbor_search.hpp
+++ b/src/mlpack/methods/neighbor_search/neighbor_search.hpp
@@ -42,7 +42,10 @@ namespace neighbor /** Neighbor-search routines.  These include
  *
  * @tparam SortPolicy The sort policy for distances; see NearestNeighborSort.
  * @tparam MetricType The metric to use for computation.
- * @tparam TreeType The tree type to use.
+ * @tparam MatType The type of data matrix.
+ * @tparam TreeType The tree type to use; must adhere to the TreeType API.
+ * @tparam TraversalType The type of traversal to use (defaults to the tree's
+ *      default traverser).
  */
 template<typename SortPolicy = NearestNeighborSort,
          typename MetricType = mlpack::metric::EuclideanDistance,