Skip to content

Commit 0856a20

Browse files
authored
docs: Clarify SyncMultiFrameListener API usage
Fix #851.
1 parent 221a58d commit 0856a20

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

include/libfreenect2/frame_listener_impl.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,18 +58,18 @@ class LIBFREENECT2_API SyncMultiFrameListener : public FrameListener
5858
bool hasNewFrame() const;
5959

6060
/** Wait milliseconds for new frames.
61-
* @param[out] frame Caller is responsible to release the frames.
61+
* @param[out] frame Caller is responsible to release the frames in `frame`.
6262
* @param milliseconds Timeout. This parameter is ignored if not built with C++11 threading support.
6363
* @return true if a frame is received; false if not.
6464
*/
6565
bool waitForNewFrame(FrameMap &frame, int milliseconds);
6666

6767
/** Wait indefinitely for new frames.
68-
* @param[out] frame Caller is responsible to release the frames.
68+
* @param[out] frame Caller is responsible to release the frames in `frame`.
6969
*/
7070
void waitForNewFrame(FrameMap &frame);
7171

72-
/** Shortcut to delete all frames */
72+
/** Shortcut to delete all frames in `frame`. */
7373
void release(FrameMap &frame);
7474

7575
virtual bool onNewFrame(Frame::Type type, Frame *frame);

0 commit comments

Comments
 (0)