Comment & documentation spelling and grammar improved

lambdatiger · Jan 15, 2024 · ff46233 · ff46233
1 parent a081237
commit ff46233
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 15 deletions.
diff --git a/addons/frag/functions/fnc_dev_addRound.sqf b/addons/frag/functions/fnc_dev_addRound.sqf
@@ -29,7 +29,7 @@ if (_isSidePlayer) then {
 } else {
     GVAR(dev_trackLines) set [getObjectID _projectile, [[getposATL _projectile], [1, 0, 0, 1]]];
 };
-// eventhandler to track round and cleanup when round is "dead"
+// event handler to track round and cleanup when round is "dead"
 [
     {
         if (isGamePaused) exitWith {};
@@ -48,7 +48,7 @@ if (_isSidePlayer) then {
 
 if (!_addProjectileEventHandlers) exitWith {};
 
-// Add hitpart eventHandler
+// Add hitPart eventHandler
 _projectile addEventHandler [
     "HitPart",
     {
@@ -61,7 +61,7 @@ _projectile addEventHandler [
     }
 ];
 
-// Add explode eventHandler
+// Add explode event handler
 _projectile addEventHandler [
     "Explode",
     {

diff --git a/addons/frag/functions/fnc_dev_clearTraces.sqf b/addons/frag/functions/fnc_dev_clearTraces.sqf
@@ -1,7 +1,7 @@
 #include "..\script_component.hpp"
 /*
  * Author: Lambda.Tiger
- * Cleares all dev spheres and traces
+ * Clears all dev spheres and traces
  *
  * Arguments:
  * None

diff --git a/addons/frag/functions/fnc_dev_fragCalcDump.sqf b/addons/frag/functions/fnc_dev_fragCalcDump.sqf
@@ -3,7 +3,7 @@
  * Author: Lambda.Tiger, based on fnc_dev_debugAmmo by "ACE-Team"
  * Dumps all ammo types to see if there's any reason to spawn fragments
  * given hit power and distance. Good for grasping the values used in
- * shouldFrag to cull non-fragementing rounds
+ * shouldFrag to cull non-fragmenting rounds
  *
  * Arguments:
  * 0: Display rounds that will never frag (power < 5).

diff --git a/addons/frag/functions/fnc_dev_trackHitBox.sqf b/addons/frag/functions/fnc_dev_trackHitBox.sqf
@@ -1,10 +1,10 @@
 #include "..\script_component.hpp"
 /*
  * Author: Lambda.Tiger
- * Add a hitbox outline to an object
+ * Add a hit box outline to an object
  *
  * Arguments:
- * 0 Object to draw hitbox <OBJECT>:
+ * 0: Object to draw the hit box of <OBJECT>:
  * 1: Add sphere at object origin <BOOL>
  *
  * Return Value:

diff --git a/addons/frag/functions/fnc_dev_trackObj.sqf b/addons/frag/functions/fnc_dev_trackObj.sqf
@@ -4,9 +4,9 @@
  * This function adds an object to have it's course tracked (every frame).
  *
  * Arguments:
- * 0: Object to draw hitbox <OBJECT>
+ * 0: Object to draw track OBJECT>
  * 1: Color of trace <STRING>
- * 2: Whether the object is a projectile <BOOL>
+ * 2: Whether the object is a projectile or whether to add projectile EHs <BOOL>
  *
  * Return Value:
  * None
@@ -37,7 +37,7 @@ private _colorArray = switch (toLowerANSI _color) do {
 };
 GVAR(dev_trackLines) set [getObjectID _object, [1, [getposATL _object], _colorArray]];
 
-// eventhandler to track round and cleanup when round is "dead"
+// event handler to track round and cleanup when round is "dead"
 [
     {
         if (isGamePaused) exitWith {};
@@ -58,7 +58,7 @@ GVAR(dev_trackLines) set [getObjectID _object, [1, [getposATL _object], _colorAr
     [_object]
 ] call CBA_fnc_addPerFrameHandler;
 
-// Projectile eventhandlers that add spheres and points for more accurate round tracking
+// Projectile event handlers that add spheres and points for more accurate round tracking
 if (!_isProj) exitWith {};
 
 _object addEventHandler [

diff --git a/addons/frag/functions/fnc_doFrag.sqf b/addons/frag/functions/fnc_doFrag.sqf
@@ -28,7 +28,7 @@ params [
     ["_shotParents", [objNull, objNull], [[]]]
 ];
 
-// Check for vehicle holdoff timeout
+// Check for vehicle hold-off timeout
 private _shotParentVic = _shotParents#0;
 if (_shotParentVic getVariable [QGVAR(nextFragTime), -1] > CBA_missionTime) exitWith {
     TRACE_1("vehicleTimeExit",_shotParentVic);

diff --git a/addons/frag/functions/fnc_doFragTargeted.sqf b/addons/frag/functions/fnc_doFragTargeted.sqf
@@ -10,7 +10,7 @@
  * 2: Maximum range of fragments to calculate <SCALAR>
  * 3: Maximum number of fragments to produce <SCALAR>
  * 4: Types of fragments <ARRAY>
- * 5: A modified parameter used to calulate whether a framgent hits <SCALAR>
+ * 5: A modified parameter used to calculate whether a fragment hits <SCALAR>
  * 6: Shot parent <ARRAY>
  *
  * Return Value:

diff --git a/addons/frag/functions/fnc_getFragInfo.sqf b/addons/frag/functions/fnc_getFragInfo.sqf
@@ -42,12 +42,12 @@ if (isArray (configFile >> "cfgAmmo" >> _ammo >> QGVAR(CLASSES))) then {
  * GURNEY_C = sqrt(2E)
  *
  * _chargeMass = 185; - grams of comp-b
- * _metalMass = 210; - grams of fragmentating metal
+ * _metalMass = 210; - grams of metal are accelerated by explosion
  * _geometryCoefficient = 3/5; - spherical K factor
  * _gurneyConstant = 2843; - Gurney constant of comp-b in /ms
  *
  * _chargeMass = 429; - grams of tritonal
- * _metalMass = 496; - grams of fragmentating metal
+ * _metalMass = 496; - grams of metal are accelerated by explosion
  * _geometryCoefficient = 1/2; - cylindrical K factor
  * _gurneyConstant = 2320; - Gurney constant of tritonal in m/s
  * Equation - 0.8 for empirical 80% speed