[mlpack-git] master: Make sure doxygen picks up info on typedefs. (89b6cb8)

gitdub at big.cc.gt.atl.ga.us gitdub at big.cc.gt.atl.ga.us
Sat Aug 29 11:47:23 EDT 2015


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

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/ad4cc1bfc9b3e9897ef5340940afaa2227b03223...07f205fe90f9e6df5080c509fd36684758eb71cd

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

commit 89b6cb8d1984d2c5d30233f4c30d1fff82847a62
Author: Ryan Curtin <ryan at ratml.org>
Date:   Fri Aug 28 11:18:09 2015 -0400

    Make sure doxygen picks up info on typedefs.


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

89b6cb8d1984d2c5d30233f4c30d1fff82847a62
 src/mlpack/core/metrics/lmetric.hpp | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/src/mlpack/core/metrics/lmetric.hpp b/src/mlpack/core/metrics/lmetric.hpp
index ecd9648..e96e94d 100644
--- a/src/mlpack/core/metrics/lmetric.hpp
+++ b/src/mlpack/core/metrics/lmetric.hpp
@@ -92,29 +92,30 @@ class LMetric
 
 // Convenience typedefs.
 
-/***
+/**
  * The Manhattan (L1) distance.
  */
 typedef LMetric<1, false> ManhattanDistance;
 
-/***
- * The squared Euclidean (L2) distance.
+/**
+ * The squared Euclidean (L2) distance.  Note that this is not technically a
+ * metric!  But it can sometimes be used when distances are required.
  */
 typedef LMetric<2, false> SquaredEuclideanDistance;
 
-/***
+/**
  * The Euclidean (L2) distance.
  */
 typedef LMetric<2, true> EuclideanDistance;
 
-/***
- * The L-infinity distance
+/**
+ * The L-infinity distance.
  */
 typedef LMetric<INT_MAX, false> ChebyshevDistance;
 
 
-}; // namespace metric
-}; // namespace mlpack
+} // namespace metric
+} // namespace mlpack
 
 // Include implementation.
 #include "lmetric_impl.hpp"



More information about the mlpack-git mailing list