inc-doc2 nits/finishing touches

plugins/include/amxmodx.inc

@@ -100,8 +100,8 @@ forward plugin_end();
 /**
  * Called when a message is about to be logged.
  *
- * @note Message data and information can be retrieved using the read_log set of
+ * @note Message data and information can be retrieved using the read_log* set
- *       functions.
+ * 		 of functions.
  *
  * @return      PLUGIN_CONTINUE to let the log message through
  *              PLUGIN_HANDLED or higher to stop the log message
@@ -687,40 +687,34 @@ native read_datatype();
 /**
  * Retrieves current log message.
  *
- * @note Can only be used inside of the plugin_log() forward.
+ * @note Should only be used inside of the plugin_log() forward.
  *
  * @param output    Buffer to copy log message to
  * @param len       Maximum buffer size
  *
  * @return          Number of cells written to buffer
- * @error           If called outside of the plugin_log() forward, an error is
- *                  thrown.
  */
 native read_logdata(output[], len);
 
 /**
  * Returns number of log message arguments.
  *
- * @note Can only be used inside of the plugin_log() forward.
+ * @note Should only be used inside of the plugin_log() forward.
  *
  * @return          Number of arguments in the log message
- * @error           If called outside of the plugin_log() forward, an error is
- *                  thrown.
  */
 native read_logargc();
 
 /**
  * Retrieves argument of log message.
  *
- * @note Can only be used inside of the plugin_log() forward.
+ * @note Should only be used inside of the plugin_log() forward.
  *
  * @param id        Argument index, starting from 0
  * @param output    Buffer to copy log argument to
  * @param len       Maximum buffer size
  *
  * @return          Number of cells written to buffer
- * @error           If called outside of the plugin_log() forward, an error is
- *                  thrown.
  */
 native read_logargv(id, output[], len);
 
@@ -871,7 +865,6 @@ native get_amxx_verstring(buffer[], length);
  * @error           If the client index is not within the range of 1 to
  *                  MaxClients an error will be thrown.
  */
-
 native get_user_attacker(index, ...);
 
 /**

plugins/include/csstats.inc

@@ -75,7 +75,9 @@ native get_user_wrstats(index, wpnindex, stats[8], bodyhits[8]);
  * server.
  *
  * @note The permanent storage is updated on every respawn or client disconnect.
- * @note Player rank is determined by the difference of kills to deaths.
+ * @note Player rank is determined by the customizable "get_score" function in
+ *       "data/csstats.amxx". By default it uses the difference of kills to
+ *       deaths/teamkills.
  * @note For a list of possible body hitplaces see the HIT_* constants in
  *       amxconst.inc
  * @note The fields in the statistics are:
@@ -199,7 +201,9 @@ native reset_user_wstats(index);
  * incremental access.
  *
  * @note The permanent storage is updated on every respawn or client disconnect.
- * @note Player rank is determined by the difference of kills to deaths.
+ * @note Player rank is determined by the customizable "get_score" function in
+ *       "data/csstats.amxx". By default it uses the difference of kills to
+ *       deaths/teamkills.
  * @note For a list of possible body hitplaces see the HIT_* constants in
  *       amxconst.inc
  * @note The fields in the statistics are:

plugins/include/cstrike.inc

@@ -246,19 +246,19 @@ native cs_get_user_bpammo(index, weapon);
  *       amxconst.inc
  * @note Some weapons share ammo types and therefore ammo backpack pools. List
  *       of ammo types:
- *       awp - ammo_338magnum
+ *       ammo_338magnum  - awp
- *       scout, ak47, g3sg1 - ammo_762nato
+ *       ammo_762nato    - scout, ak47, g3sg1
- *       m249 - ammo_556natobox
+ *       ammo_556natobox - m249
- *       famas, m4a1, aug, sg550, galil, sg552 - ammo_556nato
+ *       ammo_556nato    - famas, m4a1, aug, sg550, galil, sg552
- *       m3, xm1014 - ammo_buckshot
+ *       ammo_buckshot   - m3, xm1014
- *       usp, ump45, mac10 - ammo_45acp
+ *       ammo_45acp      - usp, ump45, mac10
- *       fiveseven, p90 - ammo_57mm
+ *       ammo_57mm       - fiveseven, p90
- *       deagle - ammo_50ae
+ *       ammo_50ae       - deagle
- *       p228 - ammo_357sig
+ *       ammo_357sig     - p228
- *       glock, mp5, tmp, elites - ammo_9mm
+ *       ammo_9mm        - glock, mp5, tmp, elites
- *       hegrenade - /
+ *       /               - hegrenade
- *       flashbang - /
+ *       /               - flashbang
- *       smokegrenade - /
+ *       /               - smokegrenade
  *
  * @param index     Client index
  * @param weapon    Weapon id
@@ -1061,7 +1061,7 @@ native cs_set_c4_explode_time(index, Float:value);
 /**
  * Returns if the bomb is being defused.
  *
- * @param index     C4 entity
+ * @param c4index   C4 entity
  *
  * @return          1 if the bomb is being defused, 0 otherwise
  * @error           If the provided entity index is not a bomb, an error will be
@@ -1072,7 +1072,7 @@ native bool:cs_get_c4_defusing(c4index);
 /**
  * Sets if the bomb is being defused.
  *
- * @param index     C4 entity
+ * @param c4index   C4 entity
  * @param defusing  True if the bomb should be defused, false otherwise
  *
  * @noreturn

plugins/include/csx.inc

@@ -154,7 +154,7 @@ forward bomb_defused(defuser);
 native custom_weapon_add(const wpnname[], melee = 0, const logname[] = "");
 
 /**
- * Trigger a damage event on a custom weapon, adding it to the internal stats.
+ * Triggers a damage event on a custom weapon, adding it to the internal stats.
  *
  * @note This will also call the client_damage() and client_kill() forwards if
  *       applicable.
@@ -175,7 +175,7 @@ native custom_weapon_add(const wpnname[], melee = 0, const logname[] = "");
 native custom_weapon_dmg(weapon, att, vic, damage, hitplace = 0);
 
 /**
- * Add a shot event on a custom weapon to the internal stats.
+ * Adds a shot event on a custom weapon to the internal stats.
  *
  * @param weapon    Custom weapon id
  * @param index     Client index
@@ -184,7 +184,7 @@ native custom_weapon_dmg(weapon, att, vic, damage, hitplace = 0);
  * @error           If the weapon id is not a custom weapon or an invalid client
  *                  index is provided, an error will be thrown.
  */
-native custom_weapon_shot(weapon, index); // weapon id , player id
+native custom_weapon_shot(weapon, index);
 
 /**
  * Returns if the weapon is considered a melee weapon.

plugins/include/cvars.inc

@@ -156,7 +156,7 @@ native disable_cvar_hook(cvarhook:handle);
 native enable_cvar_hook(cvarhook:handle);
 
 /**
- * Returns a flags of a cvar. The cvar is accessed by name.
+ * Returns flags of a cvar. The cvar is accessed by name.
  *
  * @note For a list of possible flags see the FCVAR_* constants in amxconst.inc
  * @note Accessing a Cvar by name is slower than direct pointer access, which is

plugins/include/datapack.inc

@@ -24,7 +24,6 @@
  *       Failing to free handles will result in the plugin and AMXX leaking
  *       memory.
  */
-
 enum DataPack
 {
 	Invalid_DataPack = 0