Fix documentation.

This commit is contained in:
Jari Vetoniemi 2014-04-14 19:25:04 +03:00
parent bcda540401
commit 4f72d188ad
2 changed files with 23 additions and 16 deletions

View File

@ -170,6 +170,22 @@ void bmMenuSetUserdata(bmMenu *menu, void *userdata);
*/
void* bmMenuGetUserdata(bmMenu *menu);
/**
* Set filter text to bmMenu instance.
*
* @param menu bmMenu instance where to set filter.
* @param filter Null terminated C "string" to act as filter.
*/
void bmMenuSetFilter(bmMenu *menu, const char *filter);
/**
* Get filter text from bmMenu instance.
*
* @param menu bmMenu instance where to get filter.
* @return Const pointer to current filter text, may be **NULL** if empty.
*/
const char* bmMenuGetFilter(bmMenu *menu);
/**
* Set active filter mode to bmMenu instance.
*
@ -429,22 +445,6 @@ void bmItemSetUserdata(bmItem *item, void *userdata);
*/
void* bmItemGetUserdata(bmItem *item);
/**
* Set filter text to bmMenu instance.
*
* @param menu bmMenu instance where to set filter.
* @param filter Null terminated C "string" to act as filter.
*/
void bmMenuSetFilter(bmMenu *menu, const char *filter);
/**
* Get filter text from bmMenu instance.
*
* @param menu bmMenu instance where to get filter.
* @return Const pointer to current filter text, may be **NULL** if empty.
*/
const char* bmMenuGetFilter(bmMenu *menu);
/**
* Set text to bmItem instance.
*

View File

@ -1,5 +1,12 @@
#include "version.h"
/**
* Get version of the library in 'major.minor.patch' format.
*
* @see @link http://semver.org/ Semantic Versioning @endlink
*
* @return Null terminated C "string" to version string.
*/
const char *bmVersion(void)
{
return BM_VERSION;