diff options
| author | Jari Vetoniemi <mailroxas@gmail.com> | 2014-04-10 20:19:15 +0300 |
|---|---|---|
| committer | Jari Vetoniemi <mailroxas@gmail.com> | 2014-04-10 20:19:15 +0300 |
| commit | 05212f5e44571945b40f72ae70ec7012af85fe75 (patch) | |
| tree | 87b5e4bc3cd52bef8f4bf67abc9e746755f2d6b1 /lib/bemenu.h | |
| parent | 1f51a67589213a93ddd80843a909b92c2670ddc8 (diff) | |
| download | bemenu-05212f5e44571945b40f72ae70ec7012af85fe75.tar.gz bemenu-05212f5e44571945b40f72ae70ec7012af85fe75.tar.bz2 bemenu-05212f5e44571945b40f72ae70ec7012af85fe75.zip | |
Improve documentation.
Diffstat (limited to 'lib/bemenu.h')
| -rw-r--r-- | lib/bemenu.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/lib/bemenu.h b/lib/bemenu.h index 35a94e5..4534966 100644 --- a/lib/bemenu.h +++ b/lib/bemenu.h @@ -239,6 +239,8 @@ int bmMenuSetHighlighted(bmMenu *menu, bmItem *item); /** * Get highlighted item from bmMenu instance. * + * @warning The pointer returned by this function may be invalid after items change. + * * @param menu bmMenu instance from where to get highlighted item. * @return Selected bmItem instance, **NULL** if none highlighted. */ @@ -247,7 +249,7 @@ bmItem* bmMenuGetHighlightedItem(const bmMenu *menu); /** * Set selected items to bmMenu instance. * - * @warning The list won't be copied. + * @warning The list won't be copied, do not free it. * * @param menu bmMenu instance where items will be set. * @param items Array of bmItem pointers to set. @@ -259,6 +261,8 @@ int bmMenuSetSelectedItems(bmMenu *menu, bmItem **items, unsigned int nmemb); /** * Get selected items from bmMenu instance. * + * @warning The pointer returned by this function may be invalid after selection or items change. + * * @param menu bmMenu instance from where to get selected items. * @param outNmemb Reference to unsigned int where total count of returned items will be stored. * @return Pointer to array of bmItem pointers. |