Skip to content

Commit 4c7e03c

Browse files
committed
docs: Update API descriptions
1 parent a71ab1f commit 4c7e03c

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

doc/mainpage.dox

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
/** @mainpage API Reference
22

3+
Older versions: [0.1](0.1).
4+
35
Introduction
46
============
57

include/libfreenect2/frame_listener.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class LIBFREENECT2_API Frame
4747
/** Available types of frames. */
4848
enum Type
4949
{
50-
Color = 1, ///< 1920x1080
50+
Color = 1, ///< 1920x1080. BGRX or RGBX.
5151
Ir = 2, ///< 512x424 float. Range is [0.0, 65535.0].
5252
Depth = 4 ///< 512x424 float, unit: millimeter. Non-positive, NaN, and infinity are invalid or missing data.
5353
};

include/libfreenect2/libfreenect2.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ class LIBFREENECT2_API Freenect2Device
164164
*
165165
* FrameListener will receive frames when the device is running.
166166
*
167-
* @return Undefined. To be defined in 0.2.
167+
* @return true if ok, false if error.
168168
*/
169169
virtual bool start() = 0;
170170

@@ -173,19 +173,19 @@ class LIBFREENECT2_API Freenect2Device
173173
*
174174
* @param rgb Whether to enable RGB stream.
175175
* @param depth Whether to enable depth stream.
176-
* @return Undefined. To be defined in 0.2.
176+
* @return true if ok, false if error.
177177
*/
178178
virtual bool startStreams(bool rgb, bool depth) = 0;
179179

180180
/** Stop data processing.
181181
*
182-
* @return Undefined. To be defined in 0.2.
182+
* @return true if ok, false if error.
183183
*/
184184
virtual bool stop() = 0;
185185

186186
/** Shut down the device.
187187
*
188-
* @return Undefined. To be defined in 0.2.
188+
* @return true if ok, false if error.
189189
*/
190190
virtual bool close() = 0;
191191
};

0 commit comments

Comments
 (0)