X-Git-Url: https://git.ucc.asn.au/?p=matches%2FMCTX3420.git;a=blobdiff_plain;f=server%2Fimage.c;fp=server%2Fimage.c;h=0e4ff48603e1d2ee740cdd0d7fe77630f18b4391;hp=dcc122d28f27ce323eb525217d3a83f6b36e0d53;hb=b7a1e44bd6c984d061b0b88a8b00cf24b854a1df;hpb=7deca6b4e089e76e279ae84c0aa25728d91e8fd9

diff --git a/server/image.c b/server/image.c
index dcc122d..0e4ff48 100644
--- a/server/image.c
+++ b/server/image.c
@@ -8,6 +8,11 @@
 static CvCapture * g_capture = NULL;
 static int g_captureID = -1;
 
+/**
+ * Image stream handler. Returns an image to the user.
+ * @param context The context to work in
+ * @param params User specified parameters
+ */
 void Image_Handler(FCGIContext * context, char * params)
 {
 
@@ -53,7 +58,7 @@ void Image_Handler(FCGIContext * context, char * params)
  * @param num - Camera id
  * @param width - Width to force
  * @param height - Height to force
- * @param image - Pointer to CvMat* to set with result
+ * @param frame - Pointer to IplImage* to set with result
  * @returns true on success, false on error 
  */
  bool Camera_GetImage(int num, int width, int height,  IplImage ** frame)
@@ -97,6 +102,9 @@ void Image_Handler(FCGIContext * context, char * params)
 	return result;
 }
 
+/**
+ * Executed on cleanup. Releases the OpenCV Capture structs.
+ */
 void Image_Cleanup()
 {
 	// Release the capture and IplImage pointers