Skip to content

Commit

Permalink
Various doxygen fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
VictorLamoine committed Apr 29, 2014
1 parent f8fde2a commit 70d6897
Show file tree
Hide file tree
Showing 186 changed files with 679 additions and 634 deletions.
1 change: 0 additions & 1 deletion 2d/include/pcl/2d/edge.h
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,6 @@ namespace pcl
computeDerivativeYBackward (pcl::PointCloud<PointOutT> &output);

/** \brief Override function to implement the pcl::Filter interface
* \param output Output point cloud passed by reference
*/
void
applyFilter (pcl::PointCloud<PointOutT>& /*output*/) {}
Expand Down
8 changes: 4 additions & 4 deletions 2d/include/pcl/2d/kernel.h
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ namespace pcl
* 3x3 Sobel kernel in the X direction
*/

void sobelKernelX (pcl::PointCloud<PointT> &Kernel);
void sobelKernelX (pcl::PointCloud<PointT> &kernel);

/**
*
Expand All @@ -121,7 +121,7 @@ namespace pcl
* 3x3 Prewitt kernel in the X direction
*/

void prewittKernelX (pcl::PointCloud<PointT> &Kernel);
void prewittKernelX (pcl::PointCloud<PointT> &kernel);

/**
*
Expand All @@ -139,7 +139,7 @@ namespace pcl
* 3x3 Sobel kernel in the Y direction
*/

void sobelKernelY (pcl::PointCloud<PointT> &Kernel);
void sobelKernelY (pcl::PointCloud<PointT> &kernel);

/**
*
Expand All @@ -148,7 +148,7 @@ namespace pcl
* 3x3 Prewitt kernel in the Y direction
*/

void prewittKernelY (pcl::PointCloud<PointT> &Kernel);
void prewittKernelY (pcl::PointCloud<PointT> &kernel);

/**
*
Expand Down
2 changes: 1 addition & 1 deletion 2d/include/pcl/2d/morphology.h
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ namespace pcl
const pcl::PointCloud<PointT> &input1,
const pcl::PointCloud<PointT> &input2);

/** \Set operation \f$ output = input1 \cap input2 \f$
/** \brief Set operation \f$ output = input1 \cap input2 \f$
* \param[out] output Output point cloud passed by reference
* \param[in] input1
* \param[in] input2
Expand Down
4 changes: 2 additions & 2 deletions common/include/pcl/common/centroid.h
Original file line number Diff line number Diff line change
Expand Up @@ -1111,9 +1111,9 @@ namespace pcl
PointOutT& centroid);

/** Compute the centroid of a set of points and return it as a point.
*
* \param[in] cloud
* \param[in] indices point cloud indices that need to be used
*
* \param[out] centroid
* This is an overloaded function provided for convenience. See the
* documentation for computeCentroid().
*
Expand Down
6 changes: 3 additions & 3 deletions common/include/pcl/common/impl/pca.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@

/////////////////////////////////////////////////////////////////////////////////////////
/** \brief Constructor with direct computation
* \param[in] X input m*n matrix (ie n vectors of R(m))
* \param[in] cloud input m*n matrix (ie n vectors of R(m))
* \param[in] basis_only flag to compute only the PCA basis
*/
template<typename PointT>
pcl::PCA<PointT>::PCA (const pcl::PointCloud<PointT>& X, bool basis_only)
pcl::PCA<PointT>::PCA (const pcl::PointCloud<PointT> &cloud, bool basis_only)
{
Base ();
basis_only_ = basis_only;
setInputCloud (X.makeShared ());
setInputCloud (cloud.makeShared ());
compute_done_ = initCompute ();
}

Expand Down
10 changes: 5 additions & 5 deletions common/include/pcl/common/intensity.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ namespace pcl
struct IntensityFieldAccessor
{
/** \brief get intensity field
* \param[in] point p
* \param[in] p point
* \return p.intensity
*/
inline float
Expand All @@ -60,7 +60,7 @@ namespace pcl
return p.intensity;
}
/** \brief gets the intensity value of a point
* \param[in/out] p point for which intensity to be get
* \param p point for which intensity to be get
* \param[in] intensity value of the intensity field
*/
inline void
Expand All @@ -69,7 +69,7 @@ namespace pcl
intensity = p.intensity;
}
/** \brief sets the intensity value of a point
* \param[in/out] p point for which intensity to be set
* \param p point for which intensity to be set
* \param[in] intensity value of the intensity field
*/
inline void
Expand All @@ -78,7 +78,7 @@ namespace pcl
p.intensity = intensity;
}
/** \brief subtract value from intensity field
* \param[in/out] p point for which to modify inetnsity
* \param p point for which to modify inetnsity
* \param[in] value value to be subtracted from point intensity
*/
inline void
Expand All @@ -87,7 +87,7 @@ namespace pcl
p.intensity -= value;
}
/** \brief add value to intensity field
* \param[in/out] p point for which to modify inetnsity
* \param p point for which to modify inetnsity
* \param[in] value value to be added to point intensity
*/
inline void
Expand Down
9 changes: 5 additions & 4 deletions common/include/pcl/common/intersections.h
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,11 @@ namespace pcl
/** \brief Determine the line of intersection of two non-parallel planes using lagrange multipliers
* \note Described in: "Intersection of Two Planes, John Krumm, Microsoft Research, Redmond, WA, USA"
* \param[in] plane_a coefficients of plane A and plane B in the form ax + by + cz + d = 0
* \param[out] plane_b coefficients of line where line.tail<3>() = direction vector and
* line.head<3>() the point on the line closest to (0, 0, 0)
* \param[in] plane_b coefficients of line where line.tail<3>() = direction vector and
* line.head<3>() the point on the line clossest to (0, 0, 0)
* \param[out] line the intersected line to be filled
* \param[in] angular_tolerance tolerance in radians
* \return true if succeeded/planes aren't parallel
* \note Plane normal doesn't have to be normalized
*/
PCL_EXPORTS template <typename Scalar> bool
planeWithPlaneIntersection (const Eigen::Matrix<Scalar, 4, 1> &plane_a,
Expand Down Expand Up @@ -118,7 +119,7 @@ namespace pcl
* \param[in] plane_b are the coefficients of the second plane
* \param[in] plane_c are the coefficients of the third plane
* \param[in] determinant_tolerance is a limit to determine whether planes are parallel or not
* \param[out] intersection_point, the three coordinates x, y, z of the intersection point
* \param[out] intersection_point the three coordinates x, y, z of the intersection point
* \return true if succeeded/planes aren't parallel
*/
PCL_EXPORTS template <typename Scalar> bool
Expand Down
5 changes: 5 additions & 0 deletions common/include/pcl/common/io.h
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,10 @@ namespace pcl
/** \brief Copy a point cloud inside a larger one interpolating borders.
* \param[in] cloud_in the input point cloud dataset
* \param[out] cloud_out the resultant output point cloud dataset
* \param top
* \param bottom
* \param left
* \param right
* Position of cloud_in inside cloud_out is given by \a top, \a left, \a bottom \a right.
* \param[in] border_type the interpolating method (pcl::BORDER_XXX)
* BORDER_REPLICATE: aaaaaa|abcdefgh|hhhhhhh
Expand All @@ -410,6 +414,7 @@ namespace pcl
* BORDER_WRAP: cdefgh|abcdefgh|abcdefg
* BORDER_CONSTANT: iiiiii|abcdefgh|iiiiiii with some specified 'i'
* BORDER_TRANSPARENT: mnopqr|abcdefgh|tuvwxyz where m-r and t-z are orignal values of cloud_out
* \param value
* \throw pcl::BadArgumentException if any of top, bottom, left or right is negative.
* \ingroup common
*/
Expand Down
2 changes: 1 addition & 1 deletion common/include/pcl/common/random.h
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ namespace pcl
/** Constructor
* \param parameters uniform distribution parameters and generator seed
*/
UniformGenerator(const Parameters& paramters);
UniformGenerator(const Parameters& parameters);

/** Change seed value
* \param[in] seed new generator seed value
Expand Down
4 changes: 3 additions & 1 deletion common/include/pcl/range_image/bearing_angle_image.h
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ namespace pcl
reset ();

/** \brief Calculate the angle between the laser beam and the segment joining two consecutive
* \measurement points.
* measurement points.
* \param point1
* \param point2
*/
double
getAngle (const PointXYZ &point1, const PointXYZ &point2);
Expand Down
1 change: 0 additions & 1 deletion common/include/pcl/range_image/range_image.h
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,6 @@ namespace pcl
* individual pixels in the image in the x-direction
* \param angular_resolution_y the angular difference (in radians) between the
* individual pixels in the image in the y-direction
* \param angular_resolution the angle (in radians) between each sample in the depth image
* \param point_cloud_center the center of bounding sphere
* \param point_cloud_radius the radius of the bounding sphere
* \param sensor_pose an affine matrix defining the pose of the sensor (defaults to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,6 @@ namespace pcl
getAllInlierCounts () { return all_inlier_counts_; }

/** \brief Return the model coefficients of the best model found so far.
* \param model_coefficients the resultant model coefficients
*/
inline std::vector<float4>
getAllModelCoefficients ()
Expand All @@ -152,7 +151,6 @@ namespace pcl
}

/** \brief Return the model coefficients of the best model found so far.
* \param model_coefficients the resultant model coefficients
*/
inline std::vector<float3>
getAllModelCentroids ()
Expand Down
13 changes: 6 additions & 7 deletions cuda/sample_consensus/include/pcl/cuda/sample_consensus/sac.h
Original file line number Diff line number Diff line change
Expand Up @@ -128,12 +128,12 @@ namespace pcl
virtual bool
computeModel (int debug_verbosity_level = 0) = 0;

/** \brief Get a set of randomly selected indices.
/* \brief Get a set of randomly selected indices.
* \param indices the input indices vector
* \param nr_samples the desired number of point indices to randomly select
* \param indices_subset the resultant output set of randomly selected indices
*/
/* inline void
/* inline void
getRandomSamples (const IndicesPtr &indices, size_t nr_samples,
std::set<int> &indices_subset)
{
Expand All @@ -149,15 +149,14 @@ namespace pcl
getModel (Indices &model) { model = model_; }

/** \brief Return the best set of inliers found so far for this model.
* \param inliers the resultant set of inliers
*/
// inline void
// getInliers (std::vector<int> &inliers) { inliers = inliers_; }
// inline void
// getInliers (std::vector<int> &inliers) { inliers = inliers_; }
inline IndicesPtr
getInliers () { return inliers_; }

// inline void
// getInliersStencil (Indices &inliers) { inliers = inliers_stencil_; }
// inline void
// getInliersStencil (Indices &inliers) { inliers = inliers_stencil_; }
inline IndicesPtr
getInliersStencil () { return inliers_stencil_; }

Expand Down
Loading

0 comments on commit 70d6897

Please sign in to comment.