Merge pull request #1831 from jeffin143/documentation

Documentation fixup

src/mlpack/core/tree/ballbound.hpp

@@ -108,6 +108,8 @@ class BallBound
 
   /**
    * Determines if a point is within this bound.
+   *
+   * @param point Point to check the condition.
    */
   bool Contains(const VecType& point) const;
 
@@ -120,6 +122,8 @@ class BallBound
 
   /**
    * Calculates minimum bound-to-point squared distance.
+   *
+   * @param point Point to which the minimum distance is requested.
    */
   template<typename OtherVecType>
   ElemType MinDistance(
@@ -128,11 +132,15 @@ class BallBound
 
   /**
    * Calculates minimum bound-to-bound squared distance.
+   *
+   * @param other Bound to which the minimum distance is requested.
    */
   ElemType MinDistance(const BallBound& other) const;
 
   /**
    * Computes maximum distance.
+   *
+   * @param point Point to which the maximum distance is requested.
    */
   template<typename OtherVecType>
   ElemType MaxDistance(
@@ -141,11 +149,16 @@ class BallBound
 
   /**
    * Computes maximum distance.
+   *
+   * @param other Bound to which the maximum distance is requested.
    */
   ElemType MaxDistance(const BallBound& other) const;
 
   /**
    * Calculates minimum and maximum bound-to-point distance.
+   *
+   * @param point Point to which the minimum and maximum distances are
+   *     requested.
    */
   template<typename OtherVecType>
   math::RangeType<ElemType> RangeDistance(
@@ -156,6 +169,9 @@ class BallBound
    * Calculates minimum and maximum bound-to-bound distance.
    *
    * Example: bound1.MinDistanceSq(other) for minimum distance.
+   *
+   * @param other Bound to which the minimum and maximum distances are
+   *     requested.
    */
   math::RangeType<ElemType> RangeDistance(const BallBound& other) const;
 

src/mlpack/core/tree/cellbound.hpp

@@ -89,6 +89,8 @@ class CellBound
   /**
    * Initializes to specified dimensionality with each dimension the empty
    * set.
+   *
+   * @param dimension Dimensionality of bound.
    */
   CellBound(const size_t dimension);
 
@@ -219,11 +221,15 @@ class CellBound
 
   /**
    * Expands this region to encompass another bound.
+   *
+   * @param other Bound which needs to be encompassed.
    */
   CellBound& operator|=(const CellBound& other);
 
   /**
    * Determines if a point is within this bound.
+   *
+   * @param point Point to check the condition.
    */
   template<typename VecType>
   bool Contains(const VecType& point) const;

src/mlpack/core/tree/hollow_ball_bound.hpp

@@ -123,12 +123,16 @@ class HollowBallBound
 
   /**
    * Determines if a point is within this bound.
+   *
+   * @param point Point to check the condition.   
    */
   template<typename VecType>
   bool Contains(const VecType& point) const;
 
   /**
    * Determines if another bound is within this bound.
+   *
+   * @param other Bound to check the condition.
    */
   bool Contains(const HollowBallBound& other) const;
 
@@ -141,7 +145,9 @@ class HollowBallBound
   void Center(VecType& center) const { center = this->center; }
 
   /**
-   * Calculates minimum bound-to-point squared distance.
+   * Calculates minimum bound-to-point squared distance
+   *.
+   * @param point Point to which the minimum distance is requested.
    */
   template<typename VecType>
   ElemType MinDistance(const VecType& point,
@@ -150,11 +156,15 @@ class HollowBallBound
 
   /**
    * Calculates minimum bound-to-bound squared distance.
+   *
+   * @param other Bound to which the minimum distance is requested.
    */
   ElemType MinDistance(const HollowBallBound& other) const;
 
   /**
    * Computes maximum distance.
+   *
+   * @param point Point to which the maximum distance is requested.
    */
   template<typename VecType>
   ElemType MaxDistance(const VecType& point,
@@ -163,11 +173,16 @@ class HollowBallBound
 
   /**
    * Computes maximum distance.
+   *
+   * @param other Bound to which the maximum distance is requested.
    */
   ElemType MaxDistance(const HollowBallBound& other) const;
 
   /**
    * Calculates minimum and maximum bound-to-point distance.
+   *
+   * @param point Point to which the minimum and maximum distances are
+   *     requested.
    */
   template<typename VecType>
   math::RangeType<ElemType> RangeDistance(
@@ -178,6 +193,9 @@ class HollowBallBound
    * Calculates minimum and maximum bound-to-bound distance.
    *
    * Example: bound1.MinDistanceSq(other) for minimum distance.
+   *
+   * @param other Bound to which the minimum and maximum distances are
+   *     requested.
    */
   math::RangeType<ElemType> RangeDistance(const HollowBallBound& other) const;
 

src/mlpack/core/tree/hrectbound.hpp

@@ -66,6 +66,8 @@ class HRectBound
   /**
    * Initializes to specified dimensionality with each dimension the empty
    * set.
+   *
+   * @param dimension Dimensionality of bound.
    */
   HRectBound(const size_t dimension);
 
@@ -190,12 +192,16 @@ class HRectBound
 
   /**
    * Determines if a point is within this bound.
+   *
+   * @param point Point to check the condition.   
    */
   template<typename VecType>
   bool Contains(const VecType& point) const;
 
   /**
    * Determines if this bound partially contains a bound.
+   *
+   * @param other Bound to check the condition.
    */
   bool Contains(const HRectBound& bound) const;