Peter M. Groen / openbr

Commit 27564e21c43179352266eecebe353b286ec90b62

Authored by Austin Blanton
1 parent 479f4630

Additional documentation

Inline Side-by-side
Showing 1 changed file with 11 additions and 1 deletions
openbr/openbr.h
  View file @27564e2
... ... @@ -436,24 +436,34 @@ BR_EXPORT br_template br_load_img(const char *data, int len);
436 436 /*!
437 437 * \brief Unload an image to a string buffer.
438 438 * Easy way to pass an image from openbr to another programming language.
  439 + * \param tmpl Pointer to a br::Template.
439 440 */
440 441 BR_EXPORT unsigned char* br_unload_img(br_template tmpl);
441 442 /*!
442 443 * \brief Get the number of rows in an image.
  444 + * \param tmpl Pointer to a br::Template.
443 445 */
444 446 BR_EXPORT int br_img_rows(br_template tmpl);
445 447 /*!
446 448 * \brief Get the number of columns in an image.
  449 + * \param tmpl Pointer to a br::Template.
447 450 */
448 451 BR_EXPORT int br_img_cols(br_template tmpl);
449 452 /*!
450 453 * \brief Get the number of channels in an image.
  454 + * \param tmpl Pointer to a br::Template.
451 455 */
452 456 BR_EXPORT int br_img_channels(br_template tmpl);
453 457 /*!
454   - * \brief Enroll a br::Template from the C API! Returns a br::TemplateList
  458 + * \brief Enroll a br::Template from the C API! Returns a pointer to a br::TemplateList
  459 + * \param tmpl Pointer to a br::Template.
455 460 */
456 461 BR_EXPORT br_template_list br_enroll_template(br_template tmpl);
  462 +/*!
  463 + * \brief Get a pointer to a br::Template at a specified index.
  464 + * \param tl Pointer to a br::TemplateList.
  465 + * \param index The index of the br::Template.
  466 + */
457 467 BR_EXPORT br_template br_get_template(br_template_list tl, int index);
458 468  
459 469 /*! @}*/
... ...