Permalink
Browse files

๐Ÿ’„

1 parent 52eddcf commit 5a7ca5073906c95c3d5294eebfc5d69915087c80 @VictorLamoine VictorLamoine committed Aug 27, 2014
@@ -48,6 +48,7 @@ namespace pcl
{
/** Tests if the 3D components of a point are all finite
* param[in] pt point to be tested
+ * return true if finite, false otherwise
*/
template <typename PointT> inline bool
isFinite (const PointT &pt)
@@ -155,7 +155,7 @@ namespace pcl
/** \brief Constructor.
*
- * \param[i] window_size number of most recent events that are
+ * \param[in] window_size number of most recent events that are
* considered in frequency estimation (default: 30) */
EventFrequency (size_t window_size = 30)
: window_size_ (window_size)
@@ -171,7 +171,7 @@ namespace pcl
}
/** \brief Register a different threshold function
- * \param[in] pointer to a threshold function
+ * \param[in] thresh pointer to a threshold function
*/
void
setThresholdFunction (boost::function<bool (double)> thresh)
@@ -180,7 +180,7 @@ namespace pcl
}
/** \brief Register a different threshold function
- * \param[in] pointer to a threshold function
+ * \param[in] thresh_function pointer to a threshold function
* \param[in] instance
*/
template <typename T> void
@@ -57,7 +57,7 @@ namespace pcl
/** \brief Constructor.
- * Sets \ref leaf_size_ to 0 and \ref searchable_ to false.
+ * Sets \ref leaf_size_ to 0.
*/
VoxelGridLabel () {};
@@ -1743,10 +1743,11 @@ namespace pcl
////////////////////////////////////////////////////////////////////////
/** \brief Removes mesh elements and data that are marked as deleted from the container.
- * \param IndexContainerT e.g. std::vector \<VertexIndex\>
- * \param ElementContainerT e.g. std::vector \<Vertex\>
- * \param DataContainerT e.g. std::vector \<VertexData\>
- * \param HasDataT Integral constant specifying if the mesh has data associated with the elements.
+ * \tparam ElementContainerT e.g. std::vector \<Vertex\>
+ * \tparam DataContainerT e.g. std::vector \<VertexData\>
+ * \tparam IndexContainerT e.g. std::vector \<VertexIndex\>
+ * \tparam HasDataT Integral constant specifying if the mesh has data associated with the elements.
+ *
* \param[in, out] elements Container for the mesh elements. Resized to the new size.
* \param[in, out] data_cloud Container for the mesh data. Resized to the new size.
* \return Container with the same size as the old input data. Holds the indices to the new elements for each non-deleted element and an invalid index if it is deleted.
@@ -71,6 +71,7 @@ namespace pcl
typedef std::pair<pcl::PCLImage, pcl::PCLImage> PairOfImages;
public:
+ /** @cond */
typedef boost::shared_ptr<EnsensoGrabber> Ptr;
typedef boost::shared_ptr<const EnsensoGrabber> ConstPtr;
@@ -84,6 +85,7 @@ namespace pcl
typedef void
(sig_cb_ensenso_point_cloud_images) (const pcl::PointCloud<pcl::PointXYZ>::Ptr &,
const boost::shared_ptr<PairOfImages> &);
+ /** @endcond */
/** @brief Constructor */
EnsensoGrabber ();
@@ -232,7 +234,6 @@ namespace pcl
storeEEPROMExtrinsicCalibration () const;
/** @brief Clear the extrinsic calibration stored in the EEPROM
- * @param[in] target The target to overwrite
* @return True if successful, false otherwise */
bool
clearEEPROMExtrinsicCalibration ();
@@ -425,7 +426,7 @@ namespace pcl
/** @brief Reference to the NxLib tree root
* @warning You must handle NxLib exceptions manually when playing with @ref root_ !
- * See @ref ensensoExceptionHandling in ensenso_grabber.cpp */
+ * See ensensoExceptionHandling in ensenso_grabber.cpp */
boost::shared_ptr<const NxLibItem> root_;
/** @brief Reference to the camera tree
@@ -63,7 +63,7 @@ namespace pcl
typedef boost::chrono::high_resolution_clock::time_point Timestamp;
/** \brief Constructor
- * \param[in] depth_meta_data the actual data from the OpenNI library
+ * \param[in] depth_metadata the actual data from the OpenNI library
* \param[in] baseline the baseline of the "stereo" camera, i.e. the distance between the projector and the IR camera for
* Primesense like cameras. e.g. 7.5cm for PSDK5 and PSDK6 reference design.
* \param[in] focal_length focal length of the "stereo" frame.
@@ -350,6 +350,7 @@ namespace pcl
* \param[in] min The minimum corner of the boudning box to query.
* \param[out] max The maximum corner of the bounding box to query.
* \param[in] query_depth The depth in the tree at which to look for the points. Only returns points within the given bounding box at the specified \c query_depth.
+ * \param percent
* \param[out] dst The destination in which to return the points.
*
*/
@@ -101,8 +101,7 @@ namespace pcl
/**
* \brief Set the transformation matrix, which is used in order to transform the given point cloud, the ground plane and the intrinsics matrix to the internal coordinate frame.
- *
- * \param[in] cloud A pointer to the input cloud.
+ * \param[in] transformation
*/
void
setTransformation (const Eigen::Matrix3f& transformation);

0 comments on commit 5a7ca50

Please sign in to comment.