Skip to content

Commit fee452d

Browse files
committed
docs: Remove duplicate comments in the code
Some comments in the code are duplicate of those in the headers.
1 parent d630d0f commit fee452d

File tree

4 files changed

+3
-50
lines changed

4 files changed

+3
-50
lines changed

include/libfreenect2/logger.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ class LIBFREENECT2_API Logger
5959
* `LIBFREENECT2_LOGGER_LEVEL` can contain a case-insensitive name of level.
6060
*/
6161
static Level getDefaultLevel();
62+
63+
/** Convert logging level to a human-readable name.
64+
*/
6265
static std::string level2str(Level level);
6366

6467
virtual ~Logger();

src/frame_listener_impl.cpp

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,6 @@ bool SyncMultiFrameListener::hasNewFrame() const
7474
return impl_->hasNewFrame();
7575
}
7676

77-
/**
78-
* Wait for a new set of frames to arrive.
79-
* @param [out] frame Retrieved frame.
80-
* @param milliseconds Timeout to wait.
81-
*/
8277
bool SyncMultiFrameListener::waitForNewFrame(FrameMap &frame, int milliseconds)
8378
{
8479
#ifdef LIBFREENECT2_THREADING_STDLIB
@@ -104,10 +99,6 @@ bool SyncMultiFrameListener::waitForNewFrame(FrameMap &frame, int milliseconds)
10499
#endif // LIBFREENECT2_THREADING_STDLIB
105100
}
106101

107-
/**
108-
* Wait for a new set of frames to arrive.
109-
* @param [out] frame Retrieved frame.
110-
*/
111102
void SyncMultiFrameListener::waitForNewFrame(FrameMap &frame)
112103
{
113104
libfreenect2::unique_lock l(impl_->mutex_);
@@ -122,10 +113,6 @@ void SyncMultiFrameListener::waitForNewFrame(FrameMap &frame)
122113
impl_->ready_frame_types_ = 0;
123114
}
124115

125-
/**
126-
* Free the frames from the synchronized set.
127-
* @param [inout] frame Frames to release.
128-
*/
129116
void SyncMultiFrameListener::release(FrameMap &frame)
130117
{
131118
for(FrameMap::iterator it = frame.begin(); it != frame.end(); ++it)
@@ -137,11 +124,6 @@ void SyncMultiFrameListener::release(FrameMap &frame)
137124
frame.clear();
138125
}
139126

140-
/**
141-
* Merge an arriving frame into the synchronized set.
142-
* @param type Type of the new frame.
143-
* @param frame Received frame.
144-
*/
145127
bool SyncMultiFrameListener::onNewFrame(Frame::Type type, Frame *frame)
146128
{
147129
if((impl_->subscribed_frame_types_ & type) == 0) return false;

src/logging.cpp

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,6 @@ Logger::Level Logger::level() const
7676
return level_;
7777
}
7878

79-
/**
80-
* Convert logging level to a human-readable name.
81-
* @param l Logging level to convert.
82-
* @return Human readable name for the logging level.
83-
*/
8479
std::string Logger::level2str(Level l)
8580
{
8681
switch(l)

src/registration.cpp

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,6 @@ void RegistrationImpl::depth_to_color(float mx, float my, float& rx, float& ry)
103103
ry = (wy / color_q) + color.cy;
104104
}
105105

106-
/**
107-
* Undistort/register a single depth data point
108-
*/
109106
void Registration::apply( int dx, int dy, float dz, float& cx, float &cy) const
110107
{
111108
impl_->apply(dx, dy, dz, cx, cy);
@@ -121,18 +118,6 @@ void RegistrationImpl::apply( int dx, int dy, float dz, float& cx, float &cy) co
121118
cx = rx * color.fx + color.cx;
122119
}
123120

124-
/**
125-
* Map color pixels onto depth data, giving an \a registered output image.
126-
* Optionally, the inverse map can also be obtained through \a bigdepth.
127-
* @param rgb RGB color image (1920x1080).
128-
* @param depth Depth image (512x424)
129-
* @param [out] undistorted Undistorted depth image.
130-
* @param [out] registered Image color image for the depth data (512x424).
131-
* @param enable_filter Use a depth buffer to remove pixels which are not visible to both cameras.
132-
* @param [out] bigdepth If not \c NULL, mapping of depth onto colors (1920x1082 'float' frame).
133-
* @param [out] color_depth_map If not \c NULL, map (512x424) for storing the color offset for each depth pixel.
134-
* @note The \a bigdepth frame has a blank top and bottom row.
135-
*/
136121
void Registration::apply(const Frame *rgb, const Frame *depth, Frame *undistorted, Frame *registered, const bool enable_filter, Frame *bigdepth, int *color_depth_map) const
137122
{
138123
impl_->apply(rgb, depth, undistorted, registered, enable_filter, bigdepth, color_depth_map);
@@ -286,18 +271,6 @@ void RegistrationImpl::apply(const Frame *rgb, const Frame *depth, Frame *undist
286271
if (!color_depth_map) delete[] depth_to_c_off;
287272
}
288273

289-
/**
290-
* Computes Euclidean coordinates of a pixel and its color from already registered
291-
* depth and color frames. I.e. constructs a point to fill a point cloud.
292-
* @param undistorted Undistorted depth frame from Registration::apply.
293-
* @param registered Registered color frame from Registration::apply.
294-
* @param r row index of depth frame this point belong to.
295-
* @param c column index of depth frame this point belong to.
296-
* @param[out] x x coordinate of point.
297-
* @param[out] y y coordinate of point.
298-
* @param[out] z z coordinate of point.
299-
* @param[out] RGB associated rgb color of point.
300-
*/
301274
void Registration::getPointXYZRGB (const Frame* undistorted, const Frame* registered, int r, int c, float& x, float& y, float& z, float& rgb) const
302275
{
303276
impl_->getPointXYZRGB(undistorted, registered, r, c, x, y, z, rgb);

0 commit comments

Comments
 (0)