docs: Clarify SyncMultiFrameListener API usage

Fix OpenKinect#851.
o-kotb · Dec 1, 2017 · 0856a20 · 0856a20
1 parent 221a58d
commit 0856a20
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/include/libfreenect2/frame_listener_impl.h b/include/libfreenect2/frame_listener_impl.h
@@ -58,18 +58,18 @@ class LIBFREENECT2_API SyncMultiFrameListener : public FrameListener
   bool hasNewFrame() const;
 
   /** Wait milliseconds for new frames.
-   * @param[out] frame Caller is responsible to release the frames.
+   * @param[out] frame Caller is responsible to release the frames in `frame`.
    * @param milliseconds Timeout. This parameter is ignored if not built with C++11 threading support.
    * @return true if a frame is received; false if not.
    */
   bool waitForNewFrame(FrameMap &frame, int milliseconds);
 
   /** Wait indefinitely for new frames.
-   * @param[out] frame Caller is responsible to release the frames.
+   * @param[out] frame Caller is responsible to release the frames in `frame`.
    */
   void waitForNewFrame(FrameMap &frame);
 
-  /** Shortcut to delete all frames */
+  /** Shortcut to delete all frames in `frame`. */
   void release(FrameMap &frame);
 
   virtual bool onNewFrame(Frame::Type type, Frame *frame);