Flummi/amxmodx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix newmenus.inc documentation (#942)

Browse Source
This commit is contained in:
OciXCrom 2021-08-07 17:30:07 +02:00 committed by GitHub
parent 301701b1da
commit b8c490b5e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
plugins/include/newmenus.inc
View File

@ -98,9 +98,9 @@
/** @endsection */ /** @endsection */
/** /**
* @brief Creates a new menu object. * Creates a new menu object.
* *
* The handler function should be prototyped as: * @note The handler function should be prototyped as:
* *
* public <function>(id, menu, item) * public <function>(id, menu, item)
* id - Client the menu is being acted upon. * id - Client the menu is being acted upon.
@ -110,7 +110,7 @@
* should never be called immediately if the item is a status * should never be called immediately if the item is a status
* code, for re-entrancy reasons. * code, for re-entrancy reasons.
* *
* The handler function should always return PLUGIN_HANDLED to block * @note The handler function should always return PLUGIN_HANDLED to block
* any old menu handlers from potentially feeding on the menu, unless * any old menu handlers from potentially feeding on the menu, unless
* that is the desired functionality. * that is the desired functionality.
* *
@ -129,14 +129,14 @@ native menu_create(const title[], const handler[], bool:ml = false);
/** /**
* Creates a menu item callback handler. * Creates a menu item callback handler.
* *
* The handler function should be prototyped as: * @note The handler function should be prototyped as:
* *
* public <function>(id, menu, item) * public <function>(id, menu, item)
* id - Client index being displayed to. * id - Client index being displayed to.
* menu - Menu resource identifier. * menu - Menu resource identifier.
* item - Item being drawn. * item - Item being drawn.
* <return> - ITEM_IGNORE to use the default functionality. ITEM_ENABLED to * <return> - ITEM_IGNORE to use the default functionality.
* explicitly enable or ITEM_DISABLED to explicitly disable. * ITEM_ENABLED to explicitly enable or ITEM_DISABLED to explicitly disable.
* *
* @param function Function name. * @param function Function name.
* @return Menu callback ID. * @return Menu callback ID.
@ -287,11 +287,11 @@ native menu_destroy(menu);
/** /**
* Returns information about a menu (if any) the client is currently viewing. * Returns information about a menu (if any) the client is currently viewing.
* *
* If newmenu is valid, then the menu will refer to the menuid associated with * @note If newmenu is valid, then the menu will refer to the menuid associated with
* the title. If newmenu is not valid, and the menu is valid, then the player * the title. If newmenu is not valid, and the menu is valid, then the player
* is viewing a menu displayed with show_menu(). * is viewing a menu displayed with show_menu().
* *
* Both may be invalid if the player is not viewing a menu. * @note Both may be invalid if the player is not viewing a menu.
* *
* @param id Client index. * @param id Client index.
* @param menu Variable to store old menu id. If none, then <1 will be * @param menu Variable to store old menu id. If none, then <1 will be
@ -307,7 +307,7 @@ native player_menu_info(id, &menu, &newmenu, &menupage=0);
/** /**
* Adds a blank line to a menu. * Adds a blank line to a menu.
* *
* When using slot=1 this might break your menu. To achieve this functionality * @note When using slot=1 this might break your menu. To achieve this functionality
* menu_addblank2 should be used. * menu_addblank2 should be used.
* *
* @param menu Menu resource identifier. * @param menu Menu resource identifier.
@ -319,9 +319,9 @@ native player_menu_info(id, &menu, &newmenu, &menupage=0);
native menu_addblank(menu, slot=1); native menu_addblank(menu, slot=1);
/** /**
* Adds a text line to a menu. Only available in amxmodx 1.8.1 and above. * Adds a text line to a menu.
* *
* When using slot=1 this might break your menu. To achieve this functionality * @note When using slot=1 this might break your menu. To achieve this functionality
* menu_addtext2 should be used. * menu_addtext2 should be used.
* *
* @param menu Menu resource identifier. * @param menu Menu resource identifier.
@ -336,12 +336,10 @@ native menu_addtext(menu, const text[], slot=1);
/** /**
* Adds a blank line to a menu, always shifting the numbering down. * Adds a blank line to a menu, always shifting the numbering down.
* *
* This will add a special item to create a blank line. It will affect the menu * @note This will add a special item to create a blank line. It will affect the menu
* item count and pagination. These items can be modified later but will ignore * item count and pagination. These items can be modified later but will ignore
* access and item callback results. * access and item callback results.
* *
* Only available in 1.8.3 and above.
*
* @param menu Menu resource identifier. * @param menu Menu resource identifier.
* *
* @return 1 on success, 0 on failure. * @return 1 on success, 0 on failure.
@ -353,12 +351,10 @@ native menu_addblank2( menu );
/** /**
* Adds a text line to a menu, always shifting the numbering down. * Adds a text line to a menu, always shifting the numbering down.
* *
* This will add a special item to create a blank line. It will affect the menu * @note This will add a special item to create a blank line. It will affect the menu
* item count and pagination. These items can be modified later but will ignore * item count and pagination. These items can be modified later but will ignore
* access and item callback results. * access and item callback results.
* *
* Only available in 1.8.3 and above.
*
* @param menu Menu resource identifier. * @param menu Menu resource identifier.
* @param text Text to add. * @param text Text to add.
* *