Skip to content
Permalink
Browse files

Correct Plugin API Documentation Formatting (#1019)

  • Loading branch information...
JoinedSenses authored and Headline committed May 29, 2019
1 parent 2803696 commit 81dc80fbd14b7eba3c20bc22a60629fc874015de
Showing with 6,438 additions and 6,335 deletions.
  1. +223 −223 plugins/include/admin.inc
  2. +22 −22 plugins/include/adminmenu.inc
  3. +106 −108 plugins/include/adt_array.inc
  4. +43 −43 plugins/include/adt_stack.inc
  5. +72 −70 plugins/include/adt_trie.inc
  6. +55 −55 plugins/include/banning.inc
  7. +16 −16 plugins/include/basecomm.inc
  8. +96 −96 plugins/include/bitbuffer.inc
  9. +63 −63 plugins/include/clientprefs.inc
  10. +229 −227 plugins/include/clients.inc
  11. +37 −37 plugins/include/commandfilters.inc
  12. +21 −21 plugins/include/commandline.inc
  13. +192 −192 plugins/include/console.inc
  14. +141 −135 plugins/include/convars.inc
  15. +32 −32 plugins/include/core.inc
  16. +105 −101 plugins/include/cstrike.inc
  17. +56 −56 plugins/include/datapack.inc
  18. +275 −268 plugins/include/dbi.inc
  19. +276 −268 plugins/include/entity.inc
  20. +213 −213 plugins/include/entity_prop_stocks.inc
  21. +80 −79 plugins/include/events.inc
  22. +192 −190 plugins/include/files.inc
  23. +73 −69 plugins/include/float.inc
  24. +199 −196 plugins/include/functions.inc
  25. +11 −11 plugins/include/geoip.inc
  26. +266 −266 plugins/include/halflife.inc
  27. +26 −25 plugins/include/handles.inc
  28. +104 −87 plugins/include/helpers.inc
  29. +198 −198 plugins/include/keyvalues.inc
  30. +27 −27 plugins/include/lang.inc
  31. +40 −40 plugins/include/logging.inc
  32. +28 −27 plugins/include/mapchooser.inc
  33. +358 −358 plugins/include/menus.inc
  34. +19 −19 plugins/include/nextmap.inc
  35. +11 −11 plugins/include/profiler.inc
  36. +160 −160 plugins/include/protobuf.inc
  37. +104 −102 plugins/include/regex.inc
  38. +136 −134 plugins/include/sdkhooks.inc
  39. +63 −63 plugins/include/sdktools.inc
  40. +3 −3 plugins/include/sdktools_client.inc
  41. +12 −12 plugins/include/sdktools_engine.inc
  42. +11 −11 plugins/include/sdktools_entinput.inc
  43. +37 −37 plugins/include/sdktools_entoutput.inc
  44. +119 −120 plugins/include/sdktools_functions.inc
  45. +76 −76 plugins/include/sdktools_gamerules.inc
  46. +33 −34 plugins/include/sdktools_hooks.inc
  47. +251 −257 plugins/include/sdktools_sound.inc
  48. +5 −5 plugins/include/sdktools_stocks.inc
  49. +56 −56 plugins/include/sdktools_stringtables.inc
  50. +56 −56 plugins/include/sdktools_tempents.inc
  51. +127 −127 plugins/include/sdktools_tempents_stocks.inc
  52. +239 −240 plugins/include/sdktools_trace.inc
  53. +12 −12 plugins/include/sdktools_variant_t.inc
  54. +35 −33 plugins/include/sdktools_voice.inc
  55. +55 −55 plugins/include/sorting.inc
  56. +216 −217 plugins/include/sourcemod.inc
  57. +165 −154 plugins/include/string.inc
  58. +15 −6 plugins/include/testing.inc
  59. +94 −82 plugins/include/textparse.inc
  60. +73 −72 plugins/include/tf2.inc
  61. +52 −47 plugins/include/tf2_stocks.inc
  62. +76 −76 plugins/include/timers.inc
  63. +114 −114 plugins/include/topmenus.inc
  64. +86 −73 plugins/include/usermessages.inc
  65. +43 −43 plugins/include/vector.inc
  66. +9 −9 plugins/include/version.inc

Large diffs are not rendered by default.

@@ -52,32 +52,32 @@
#endif

/** Category for player commands. */
#define ADMINMENU_PLAYERCOMMANDS "PlayerCommands"
#define ADMINMENU_PLAYERCOMMANDS "PlayerCommands"
/** Category for server commands. */
#define ADMINMENU_SERVERCOMMANDS "ServerCommands"
#define ADMINMENU_SERVERCOMMANDS "ServerCommands"
/** Category for voting commands. */
#define ADMINMENU_VOTINGCOMMANDS "VotingCommands"
#define ADMINMENU_VOTINGCOMMANDS "VotingCommands"

/**
* Called when the admin menu is created and 3rd party plugins can grab
* the Handle or add categories.
*
* @param topmenu Handle to the admin menu's TopMenu.
* @param topmenu Handle to the admin menu's TopMenu.
*/
forward void OnAdminMenuCreated(Handle topmenu);

/**
* Called when the admin menu is ready to have items added.
*
* @param topmenu Handle to the admin menu's TopMenu.
* @param topmenu Handle to the admin menu's TopMenu.
*/
forward void OnAdminMenuReady(Handle topmenu);

/**
* Retrieves the Handle to the admin top menu.
*
* @return Handle to the admin menu's TopMenu,
* or INVALID_HANDLE if not created yet.
* @return Handle to the admin menu's TopMenu,
* or INVALID_HANDLE if not created yet.
*/
native TopMenu GetAdminTopMenu();

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

/**
* Adds targets to an admin menu.
*
* Each client is displayed as: name (userid)
* Each item contains the userid as a string for its info.
*
* @param menu Menu Handle.
* @param source_client Source client, or 0 to ignore immunity.
* @param flags COMMAND_FILTER flags from commandfilters.inc.
* @return Number of clients added.
* @param menu Menu Handle.
* @param source_client Source client, or 0 to ignore immunity.
* @param flags COMMAND_FILTER flags from commandfilters.inc.
* @return Number of clients added.
*/
native int AddTargetsToMenu2(Handle menu, int source_client, int flags);

/**
* Re-displays the admin menu to a client after selecting an item.
* Auto-aborts if the Handle is invalid.
*
* @param topmenu TopMenu Handle.
* @param client Client index.
* @return True on success, false on failure.
* @param topmenu TopMenu Handle.
* @param client Client index.
* @return True on success, false on failure.
*/
stock bool RedisplayAdminMenu(Handle topmenu, int client)
{

0 comments on commit 81dc80f

Please sign in to comment.
You can’t perform that action at this time.