Add docs for new C API funcs

Austin Blanton
1 parent 511dae91
Showing 3 changed files with 31 additions and 2 deletions
openbr/core/core.cpp
openbr/openbr.cpp
openbr/openbr.h
@@ -187,7 +187,7 @@ struct AlgorithmCore
     void enroll(Template &data)
     {
         if (transform.isNull()) qFatal("Null transform.");
-        data = (data >> *transform);
+        data >> *transform;
     }
  
     void retrieveOrEnroll(const File &file, QScopedPointer<Gallery> &gallery, FileList &galleryFiles)
@@ -325,6 +325,12 @@ int br_img_cols(br_template tmpl)
     return t->m().cols;
 }
  
+int br_img_channels(br_template tmpl)
+{
+    Template *t = reinterpret_cast<Template*>(tmpl);
+    return t->m().channels();
+}
+
 void br_enroll_template(br_template tmpl)
 {
     Template *t = reinterpret_cast<Template*>(tmpl);
@@ -206,6 +206,10 @@ BR_EXPORT void br_fuse(int num_input_simmats, const char *input_simmats[],
  * \see br_finalize
  */
 BR_EXPORT void br_initialize(int &argc, char *argv[], const char *sdk_path = "");
+/*!
+ * \brief Wraps br::Context::initialize() with default arguments.
+ * \see br_finalize
+ */
 BR_EXPORT void br_initialize_default();
  
 /*!
@@ -419,16 +423,35 @@ BR_EXPORT void br_slave_process(const char * baseKey);
 // this will be this header's conception of a template
 // any functions that need a Template pointer
 // will take this typedef and cast it
-// (and then we'll cross our fingers)
 typedef void* br_template;
 /*!
   * \brief Load an image from a string buffer.
   *   Easy way to pass an image in memory from another programming language to openbr.
+  * \param data The image buffer.
+  * \param len The length of the buffer.
+  * \see br_unload_img
   */
 BR_EXPORT br_template br_load_img(const char *data, int len);
+/*!
+  * \brief Unload an image to a string buffer.
+  *   Easy way to pass an image from openbr to another programming language.
+  */
 BR_EXPORT unsigned char* br_unload_img(br_template tmpl);
+/*!
+  * \brief Get the number of rows in an image.
+  */
 BR_EXPORT int br_img_rows(br_template tmpl);
+/*!
+  * \brief Get the number of columns in an image.
+  */
 BR_EXPORT int br_img_cols(br_template tmpl);
+/*!
+  * \brief Get the number of channels in an image.
+  */
+BR_EXPORT int br_img_channels(br_template tmpl);
+/*!
+  * \brief Enroll a br::Template from the C API!
+  */
 BR_EXPORT void br_enroll_template(br_template tmpl);
  
 /*! @}*/