Skip to content

Commit 81dc80f

Browse files
JoinedSensesHeadline
authored andcommitted
Correct Plugin API Documentation Formatting (#1019)
1 parent 2803696 commit 81dc80f

66 files changed

Lines changed: 6438 additions & 6335 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

plugins/include/admin.inc

Lines changed: 223 additions & 223 deletions
Large diffs are not rendered by default.

plugins/include/adminmenu.inc

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -52,32 +52,32 @@
5252
#endif
5353

5454
/** Category for player commands. */
55-
#define ADMINMENU_PLAYERCOMMANDS "PlayerCommands"
55+
#define ADMINMENU_PLAYERCOMMANDS "PlayerCommands"
5656
/** Category for server commands. */
57-
#define ADMINMENU_SERVERCOMMANDS "ServerCommands"
57+
#define ADMINMENU_SERVERCOMMANDS "ServerCommands"
5858
/** Category for voting commands. */
59-
#define ADMINMENU_VOTINGCOMMANDS "VotingCommands"
59+
#define ADMINMENU_VOTINGCOMMANDS "VotingCommands"
6060

6161
/**
6262
* Called when the admin menu is created and 3rd party plugins can grab
6363
* the Handle or add categories.
6464
*
65-
* @param topmenu Handle to the admin menu's TopMenu.
65+
* @param topmenu Handle to the admin menu's TopMenu.
6666
*/
6767
forward void OnAdminMenuCreated(Handle topmenu);
6868

6969
/**
7070
* Called when the admin menu is ready to have items added.
7171
*
72-
* @param topmenu Handle to the admin menu's TopMenu.
72+
* @param topmenu Handle to the admin menu's TopMenu.
7373
*/
7474
forward void OnAdminMenuReady(Handle topmenu);
7575

7676
/**
7777
* Retrieves the Handle to the admin top menu.
7878
*
79-
* @return Handle to the admin menu's TopMenu,
80-
* or INVALID_HANDLE if not created yet.
79+
* @return Handle to the admin menu's TopMenu,
80+
* or INVALID_HANDLE if not created yet.
8181
*/
8282
native TopMenu GetAdminTopMenu();
8383

@@ -87,37 +87,37 @@ native TopMenu GetAdminTopMenu();
8787
* Each client is displayed as: name (userid)
8888
* Each item contains the userid as a string for its info.
8989
*
90-
* @param menu Menu Handle.
91-
* @param source_client Source client, or 0 to ignore immunity.
92-
* @param in_game_only True to only select in-game players.
93-
* @param alive_only True to only select alive players.
94-
* @return Number of clients added.
90+
* @param menu Menu Handle.
91+
* @param source_client Source client, or 0 to ignore immunity.
92+
* @param in_game_only True to only select in-game players.
93+
* @param alive_only True to only select alive players.
94+
* @return Number of clients added.
9595
*/
9696
native int AddTargetsToMenu(Handle menu,
97-
int source_client,
98-
bool in_game_only=true,
99-
bool alive_only=false);
97+
int source_client,
98+
bool in_game_only=true,
99+
bool alive_only=false);
100100

101101
/**
102102
* Adds targets to an admin menu.
103103
*
104104
* Each client is displayed as: name (userid)
105105
* Each item contains the userid as a string for its info.
106106
*
107-
* @param menu Menu Handle.
108-
* @param source_client Source client, or 0 to ignore immunity.
109-
* @param flags COMMAND_FILTER flags from commandfilters.inc.
110-
* @return Number of clients added.
107+
* @param menu Menu Handle.
108+
* @param source_client Source client, or 0 to ignore immunity.
109+
* @param flags COMMAND_FILTER flags from commandfilters.inc.
110+
* @return Number of clients added.
111111
*/
112112
native int AddTargetsToMenu2(Handle menu, int source_client, int flags);
113113

114114
/**
115115
* Re-displays the admin menu to a client after selecting an item.
116116
* Auto-aborts if the Handle is invalid.
117117
*
118-
* @param topmenu TopMenu Handle.
119-
* @param client Client index.
120-
* @return True on success, false on failure.
118+
* @param topmenu TopMenu Handle.
119+
* @param client Client index.
120+
* @return True on success, false on failure.
121121
*/
122122
stock bool RedisplayAdminMenu(Handle topmenu, int client)
123123
{

0 commit comments

Comments
 (0)