E2.2 API documentation

Author: kfish

include/shveu/shveu.h

@@ -86,6 +86,7 @@ extern "C" {
 
 /**
  * Open a VEU device.
+ * \retval 0 Success
  */
 int shveu_open(void);
 

include/shveu/veu_colorspace.h

@@ -17,24 +17,52 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA  02110-1301 USA
  */
 
-/* Image/Video processing: Scale, rotate, crop, color conversion */
+/** \file
+ * Image/Video processing: Scale, rotate, crop, color conversion
+ */
 
 #ifndef __VEU_COLORSPACE_H__
 #define __VEU_COLORSPACE_H__
 
+/** Rotation */
 enum {
+        /** No rotation */
 	SHVEU_NO_ROT=0,
+
+        /** Rotate 90 degrees clockwise */
 	SHVEU_ROT_90,
 };
 
-/* Image formats */
+/** Image formats */
 enum {
+        /** RGB565 */
 	SHVEU_RGB565=0,
+
+        /** YCbCr 4:2:0 */
 	SHVEU_YCbCr420,
+
+        /** YCbCr 4:2:2 */
 	SHVEU_YCbCr422,
 };
 
-/* Perform (scale|rotate) & crop between YCbCr 4:2:0 & RG565 surfaces */
+/** Perform (scale|rotate) & crop between YCbCr 4:2:0 & RG565 surfaces
+ * \param veu_index Index of which VEU to use
+ * \param src_py Pointer to Y or RGB plane of source image
+ * \param src_pc Pointer to CbCr plane of source image (ignored for RGB)
+ * \param src_width Width in pixels of source image
+ * \param src_height Height in pixels of source image
+ * \param src_pitch Line pitch of source image
+ * \param src_format Format of source image
+ * \param dst_py Pointer to Y or RGB plane of destination image
+ * \param dst_pc Pointer to CbCr plane of destination image (ignored for RGB)
+ * \param dst_width Width in pixels of destination image
+ * \param dst_height Height in pixels of destination image
+ * \param dst_pitch Line pitch of destination image
+ * \param dst_fmt Format of destination image
+ * \param rotate Rotation to apply
+ * \retval 0 Success
+ * \retval -1 Error: Attempt to perform simultaneous scaling and rotation
+ */
 int
 shveu_operation(
 	unsigned int veu_index,
@@ -52,15 +80,31 @@ shveu_operation(
 	int dst_fmt,
 	int rotate);
 
-/* Perform scale from RG565 to YCbCr 4:2:0 surface */
+/** Perform scale from RG565 to YCbCr 4:2:0 surface
+ * \param rgb565_in Pointer to input RGB565 image
+ * \param y_out Pointer to output Y plane
+ * \param c_out Pointer to output CbCr plane
+ * \param width Width in pixels of image
+ * \param height Height in pixels of image
+ * \retval 0 Success
+ */
 int shveu_rgb565_to_nv12(
 	unsigned char *rgb565_in,
 	unsigned char *y_out,
 	unsigned char *c_out,
 	unsigned long width,
 	unsigned long height);
 
-/* Perform color conversion & crop from YCbCr 4:2:0 to RG565 surface */
+/** Perform color conversion & crop from YCbCr 4:2:0 to RG565 surface
+ * \param y_in Pointer to input Y plane
+ * \param c_in Pointer to input CbCr plane
+ * \param rgb565_out Pointer to output RGB565 image
+ * \param width Width in pixels of image
+ * \param height Height in pixels of image
+ * \param pitch_in Line pitch of input image
+ * \param pitch_out Line pitch of output image
+ * \retval 0 Success
+ */
 int
 shveu_nv12_to_rgb565(
 	unsigned char *y_in,

libshveu.plan

@@ -9,7 +9,7 @@ Project plan: libshveu
 
  E2. Make a re-usable library from the existing code
  E2.1 Unique symbol naming etc. (Conrad) DONE 2009-06-24
- E2.2 API documentation (Phil, Conrad)
+ E2.2 API documentation (Phil, Conrad) DONE 2009-06-24
  E2.3 Simple file i/o example (??)
 
  E3. AIO interface