From 9a0a52b7b273e10fe146e11097206b2a325c61db Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Valentin=20Gr=C3=BCnbacher?= <nextra.24@gmail.com>
Date: Thu, 7 Aug 2014 00:46:16 +0200
Subject: [PATCH] amxmodx: Fix typos, touch up some descriptions, remove/merge
 lonely comments

---
 plugins/include/amxmodx.inc | 52 ++++++++++---------------------------
 1 file changed, 13 insertions(+), 39 deletions(-)

diff --git a/plugins/include/amxmodx.inc b/plugins/include/amxmodx.inc
index 79b7bb03..5cb45829 100755
--- a/plugins/include/amxmodx.inc
+++ b/plugins/include/amxmodx.inc
@@ -1847,7 +1847,7 @@ native server_exec();
 native emit_sound(index, channel, const sample[], Float:vol, Float:att,flags, pitch);
 
 /**
- * Registers a new ccvar for the engine.
+ * Registers a new cvar for the engine.
  *
  * @note For a list of possible cvar flags see FCVAR_* constants in amxconst.inc
  * @note If an already existing cvar is registered it will not be duplicated.
@@ -1857,7 +1857,7 @@ native emit_sound(index, channel, const sample[], Float:vol, Float:att,flags, pi
  * @param name      Cvar name
  * @param string    Default cvar value
  * @param flags     Cvar flags
- * @param fvalue
+ * @param fvalue    Unused
  *
  * @return          Unique cvar pointer
  */
@@ -1866,7 +1866,8 @@ native register_cvar(const name[], const string[], flags = 0, Float:fvalue = 0.0
 /**
  * Returns a random floating point value generated by the engine.
  *
- * @param a,b   Range of generated value, inclusive
+ * @param a     Minimum value (inclusive)
+ * @param b     Maximum value (inclusive)
  *
  * @return      Generated random value
  */
@@ -1875,7 +1876,8 @@ native Float:random_float(Float:a, Float:b);
 /**
  * Returns a random integer value generated by the engine.
  *
- * @param a,b   Range of generated value, inclusive
+ * @param a     Minimum value (inclusive)
+ * @param b     Maximum value (inclusive)
  *
  * @return      Generated random value
  */
@@ -1996,25 +1998,7 @@ native set_xvar_float(id, Float:value = 0.0);
  * @return          Module id of the matching module, -1 otherwise
  */
 native is_module_loaded(const name[]);
-/**
- * Retrieves info about a plugin by plugin index.
- *
- * @param index     Plugin index, -1 to target calling plugin
- * @param filename  Buffer to copy plugin filename to
- * @param len1      Maximum filename buffer size
- * @param name      Buffer to copy plugin name to
- * @param len2      Maximum name buffer size
- * @param version   Buffer to copy plugin version to
- * @param len3      Maximum version buffer size
- * @param author    Buffer to copy plugin author to
- * @param len4      Maximum author buffer size
- * @param status    Buffer to copy plugin status flags to
- * @param len5      Maximum status buffer size
- * @param ...       Unused and ignored
- *
- * @return          Plugin index on success, -1 if there is no plugin with given
- *                  index
- */
+
 /**
  * Retrieves info about a module by module index.
  *
@@ -2491,9 +2475,11 @@ native dbg_fmt_error(buffer[], maxLength);
  *  where instead of #define flags to compile separate versions, you can
  *  filter out the natives and modules depending on the current mod.
  * Examples of this usage are in plmenu.sma, which filters out the cstrike module.
- */
-
-/**
+ *
+ *
+ *
+ *
+ *
  * Sets a native filter.  This must be first set in plugin_natives(), but future calls will
  *  simply set a new filter.
  * This filter will allow your plugin to load even if its modules aren't loaded.  For example,
@@ -2595,18 +2581,6 @@ native LibraryExists(const library[], LibType:type);
  */
 native next_hudchannel(player);
 
-/**
- * Creates a HUD Synchronization Object.  Create one of these
- *  for each section of the screen that contains overlapping HUD messages.
- * For example, if you use both sides of the screen to display three messages
- *  that can potentially overlap, each side counts as a synchronizable area.
- * You can then use ShowSyncHudMsg() to correctly synchronize displaying the
- *  HUD message with any other messages potentially in its class.  Note that this
- *  does not yet do anything like reserve screen area, its sole purpose is to be
- *  able to wipe an old message on an auto-channel and ensure that it will not
- *  clear a message from another plugin.
- * The parameters are kept blank for future use.
- */
 /**
  * Creates a HUD synchronization object.
  *
@@ -2994,5 +2968,5 @@ native admins_flush();
 native bool:has_map_ent_class(const classname[]);
 
 
-// Keep this always at the bottom of this file
+// Always keep this at the bottom of this file
 #include <message_stocks>