Skip to content

Commit 2a960df

Browse files
author
Alex Cole
committed
Fix some documentation comments.
1 parent c105e22 commit 2a960df

7 files changed

Lines changed: 27 additions & 26 deletions

File tree

_open_mp.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public const __SAMP_INCLUDES_VERSION = 0x037030;
9494
* </code>
9595
* Thus they are encoded here as:
9696
* <code>
97-
* (major << 28) | (minor << 21) | (patch << 14) | (prerel)
97+
* (major &lt;&lt; 28) | (minor &lt;&lt; 21) | (patch &lt;&lt; 14) | (prerel)
9898
* </code>
9999
* </remarks>
100100
*/

file.inc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,11 @@ native fexist(const filename[]);
257257
* <summary>Return the size and the time stamp of a file.</summary>
258258
* <param name="filename">The name of the file.</param>
259259
* <param name="size">If the function is successful, this param-eter holds the size of the file on return.</param>
260-
* <param name="timestamp">If the function is successful, this parameter holds the time of the last modification of the file on return.</param>
260+
* <param name="timestamp">If the function is successful, this parameter holds the time of the last modification of the file on
261+
* return.</param>
261262
* <param name="attrib">If the function is successful, this parameter holds the file attributes.</param>
262-
* <param name="inode">If the function is successful, this parameter holds inode number of the file. An inode number is a number that uniquely identifies a file, and it usually indicates the physical position of (the start of) the file on the disk or memory card.</param>
263+
* <param name="inode">If the function is successful, this parameter holds inode number of the file. An inode number is a number that
264+
* uniquely identifies a file, and it usually indicates the physical position of (the start of) the file on the disk or memory card.</param>
263265
* <remarks>
264266
* In contrast to the function flength, this function does not need the file to be opened for querying its size.
265267
* <p/>
@@ -312,7 +314,8 @@ native filecrc(const filename[]);
312314
/**
313315
* <library>file</library>
314316
* <summary>Returns the free disk space.</summary>
315-
* <param name="volume">The name of the volume on systems that support multiple disks or multiple memory cards. On single-volume systems, it is optional.</param>
317+
* <param name="volume">The name of the volume on systems that support multiple disks or multiple memory cards. On single-volume systems, it
318+
* is optional.</param>
316319
* <remarks>
317320
* The maximum size that can be supported 2048 GiB (2 terabyte).
318321
* </remarks>
@@ -324,7 +327,8 @@ forward diskfree(const volume[] = "");
324327
* <library>file</library>
325328
* <summary>Set the file attributes.</summary>
326329
* <param name="filename">The name of the file.</param>
327-
* <param name="timestamp">Time of the last modification of the file. When this parameter is set to zero, the time stamp of the file is not changed.</param>
330+
* <param name="timestamp">Time of the last modification of the file. When this parameter is set to zero, the time stamp of the file is not
331+
* changed.</param>
328332
* <param name="attrib">A bit mask with the new attributes of the file. When set to 0x0F, the attributes of the file are not changed.</param>
329333
* <remarks>
330334
* The time is in number of seconds since midnight at 1 January 1970: the start of the UNIX system epoch.

omp_dialog.inc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,8 @@ native GetPlayerDialog(playerid) = GetPlayerDialogID;
201201
* <remarks>A player's dialog doesn't hide when the gamemode restarts, causing the server to print <c>"Warning:
202202
* PlayerDialogResponse PlayerId: 0 dialog ID doesn't match last sent dialog ID"</c> if a player responded
203203
* to this dialog after restart.</remarks>
204-
* <remarks>Parameters can contain different values, based on dialog's <a href="https://open.mp/docs/scripting/resources/dialogstyles">style</a>.
204+
* <remarks>Parameters can contain different values, based on dialog's
205+
* <a href="https://open.mp/docs/scripting/resources/dialogstyles">style</a>.
205206
* </remarks>
206207
* <returns>
207208
* Returning <b><c>0</c></b> in this callback will pass the dialog to another script in case no matching

omp_network.inc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,8 @@ native NetStats_MessagesRecvPerSecond(playerid);
414414
* 1.0% is outright bad.</remarks>
415415
* <remarks>This function has been found to be currently unreliable the output is not as expected when
416416
* compared to the client. Therefore this function should not be used as a packet loss kicker. </remarks>
417-
* <remarks>A more accurate packetloss function can be found here: <a href="https://sampforum.blast.hk/showthread.php?tid=281&pid=2488911#pid2488911">
417+
* <remarks>A more accurate packetloss function can be found here:
418+
* <a href="https://sampforum.blast.hk/showthread.php?tid=281&pid=2488911#pid2488911">
418419
* https://sampforum.blast.hk/showthread.php?tid=281&pid=2488911#pid2488911</a></remarks>
419420
* <returns>The percentage packet loss as a float. <b><c>0.0</c></b> if player not connected.</returns>
420421
*/

omp_player.inc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,8 @@ native bool:StopAudioStreamForPlayer(playerid);
474474
/**
475475
* <library>omp_player</library>
476476
* <summary>Creates an explosion that is only visible to a single player. This can be used to isolate
477-
* explosions from other players or to make them only appear in specific <a href="https://www.open.mp/docs/scripting/functions/SetPlayerVirtualWorld">virtual
477+
* explosions from other players or to make them only appear in specific
478+
* <a href="https://www.open.mp/docs/scripting/functions/SetPlayerVirtualWorld">virtual
478479
* worlds</a>.</summary>
479480
* <param name="playerid">The ID of the player to create the explosion for</param>
480481
* <param name="x">The x coordinate of the explosion</param>
@@ -2765,8 +2766,7 @@ forward OnPlayerStreamOut(playerid, forplayerid);
27652766
* <param name="amount">The amount of damage the player took (health and armour combined)</param>
27662767
* <param name="weaponid">The ID of the <a href="https://www.open.mp/docs/scripting/resources/weaponids">weapon/reason</a>
27672768
* for the damage</param>
2768-
* <param name="bodypart">The body part that was hit. (NOTE: This parameter was added in <b>0.3z</b>.
2769-
* Leave it out if using an older version!)</param>
2769+
* <param name="bodypart">The body part that was hit.</param>
27702770
* <seealso name="OnPlayerGiveDamage" />
27712771
* <seealso name="OnPlayerWeaponShot" />
27722772
* <remarks><a href="#GetPlayerHealth">GetPlayerHealth</a> and <a href="#GetPlayerArmour">GetPlayerArmour</a>
@@ -2799,8 +2799,7 @@ forward OnPlayerTakeDamage(playerid, issuerid, Float:amount, WEAPON:weaponid, bo
27992799
* <param name="amount">The amount of health/armour damagedid has lost (combined)</param>
28002800
* <param name="weaponid">The <a href="https://www.open.mp/docs/scripting/resources/weaponids">reason</a> that caused the
28012801
* damage</param>
2802-
* <param name="bodypart">The body part that was hit. (NOTE: This parameter was added in <b>0.3z</b>.
2803-
* Leave it out if using an older version!)</param>
2802+
* <param name="bodypart">The body part that was hit.</param>
28042803
* <seealso name="OnPlayerTakeDamage" />
28052804
* <remarks>
28062805
* Keep in mind this function can be inaccurate in some cases.<br />
@@ -3009,7 +3008,8 @@ forward OnPlayerInteriorChange(playerid, newinteriorid, oldinteriorid);
30093008
* <summary>This callback is called when the state of any supported key is changed (pressed/released).
30103009
* Directional keys do not trigger OnPlayerKeyStateChange (up/down/left/right).</summary>
30113010
* <param name="playerid">The ID of the player that pressed or released a key</param>
3012-
* <param name="newkeys">A map (bitmask) of the keys currently held - see <a href="https://www.open.mp/docs/scripting/resources/keys">here</a></param>
3011+
* <param name="newkeys">A map (bitmask) of the keys currently held - see <a href="https://www.open.mp/docs/scripting/resources/keys">here</a>
3012+
* </param>
30133013
* <param name="oldkeys">A map (bitmask) of the keys held prior to the current change - see
30143014
* <a href="https://www.open.mp/docs/scripting/resources/keys">here</a></param>
30153015
* <seealso name="GetPlayerKeys" />

omp_vehicle.inc

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1777,18 +1777,12 @@ forward OnVehicleDamageStatusUpdate(vehicleid, playerid);
17771777
* <param name="playerid">The ID of the player that sent a vehicle position sync update</param>
17781778
* <param name="passenger_seat">The ID of the seat if the player is a passenger. 0=not in vehicle,
17791779
* 1=front passenger, 2=backleft 3=backright 4+ is for coach/bus etc. with many passenger seats</param>
1780-
* <param name="new_x">The new X coordinate of the vehicle.</b>
1781-
* Leave it out if using an earlier version</param>
1782-
* <param name="new_y">The new Y coordinate of the vehicle.</b>
1783-
* Leave it out if using an earlier version</param>
1784-
* <param name="new_z">The new Z coordinate of the vehicle.</b>
1785-
* Leave it out if using an earlier version</param>
1786-
* <param name="vel_x">The new X velocity of the vehicle.</b>
1787-
* Leave it out if using an earlier version</param>
1788-
* <param name="vel_y">The new Y velocity of the vehicle.</b>
1789-
* Leave it out if using an earlier version</param>
1790-
* <param name="vel_z">The new Z velocity of the vehicle.</b>
1791-
* Leave it out if using an earlier version</param>
1780+
* <param name="new_x">The new X coordinate of the vehicle.</param>
1781+
* <param name="new_y">The new Y coordinate of the vehicle.</param>
1782+
* <param name="new_z">The new Z coordinate of the vehicle.</param>
1783+
* <param name="vel_x">The new X velocity of the vehicle.</param>
1784+
* <param name="vel_y">The new Y velocity of the vehicle.</param>
1785+
* <param name="vel_z">The new Z velocity of the vehicle.</param>
17921786
* <seealso name="OnTrailerUpdate" />
17931787
* <remarks>This callback is called very frequently per second per unoccupied vehicle. You should refrain
17941788
* from implementing intensive calculations or intensive file writing/reading operations in this callback.</remarks>

string.inc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,8 @@ native bool:ispacked(const string[]);
293293
* <summary>Convert values to text.</summary>
294294
* <param name="dest">The string that will contain the formatted result.</param>
295295
* <param name="size">The maximum number of <em>cells</em> that the dest parameter can hold. This value includes the zero terminator.</param>
296-
* <param name="pack">If <c>true</c>, the string in <c>dest</c> will become a packed string. Otherwise, the string in dest will be unpacked.</param>
296+
* <param name="pack">If <c>true</c>, the string in <c>dest</c> will become a packed string. Otherwise, the string in dest will be unpacked.
297+
* </param>
297298
* <param name="format">The string to store in <c>dest</c>, which may contain placeholders (see the notes below).</param>
298299
* <param name="...">The parameters for the placeholders. These values may be untagged, weakly tagged, or tagged as rational values.</param>
299300
* <remarks>

0 commit comments

Comments
 (0)