Merge pull request #30 from upwhere/docs-patch

reference bm_scrollbar_mode in documentation
This commit is contained in:
Jari Vetoniemi 2016-12-06 20:34:53 +02:00 committed by GitHub
commit 81f58f4c25

View File

@ -137,9 +137,9 @@ enum bm_filter_mode {
/**
* Scrollbar display mode constants for bm_menu instance scrollbar.
*
* - @link ::bm_run_result BM_SCROLLBAR_ALWAYS @endlink means that scrollbar is not displayed.
* - @link ::bm_run_result BM_SCROLLBAR_ALWAYS @endlink means that scrollbar is displayed always.
* - @link ::bm_run_result BM_SCROLLBAR_AUTOHIDE @endlink means that scrollbar is only displayed when there are more items than lines.
* - @link ::bm_scrollbar_mode BM_SCROLLBAR_ALWAYS @endlink means that scrollbar is not displayed.
* - @link ::bm_scrollbar_mode BM_SCROLLBAR_ALWAYS @endlink means that scrollbar is displayed always.
* - @link ::bm_scrollbar_mode BM_SCROLLBAR_AUTOHIDE @endlink means that scrollbar is only displayed when there are more items than lines.
*
* @link ::bm_scrollbar_mode BM_SCROLLBAR_LAST @endlink is provided for enumerating scrollbar modes.
* Using it as scrollbar mode however provides exactly same functionality as BM_SCROLLBAR_NONE.