Fix return types

ArmaForces · Dec 27, 2024 · fb3b194 · fb3b194
1 parent 30e1b58
commit fb3b194
Show file tree

Hide file tree

Showing 16 changed files with 21 additions and 14 deletions.
diff --git a/addons/civilian/functions/fnc_createCivilian.sqf b/addons/civilian/functions/fnc_createCivilian.sqf
@@ -25,4 +25,4 @@ if (_civilian isEqualTo objNull) exitWith {
     WARNING_2("Failed creating civilian %1 at %2",_unit,_position);
 };
 
-[_civilian] call FUNC(initCivilian);
+[_civilian] call FUNC(initCivilian)
diff --git a/addons/civilian/functions/fnc_getNearestCity.sqf b/addons/civilian/functions/fnc_getNearestCity.sqf
@@ -27,4 +27,5 @@ _nearestTown = [_position, _searchRadius] call EFUNC(common,getNearestCityLocati
 
 // Return city namespace or objNull if not found
 if (_nearestTown isEqualTo locationNull) exitWith {objNull};
-[_nearestTown] call FUNC(getCityByLocation);
+
+[_nearestTown] call FUNC(getCityByLocation)
diff --git a/addons/civilian/functions/fnc_getNearestVehicle.sqf b/addons/civilian/functions/fnc_getNearestVehicle.sqf
@@ -9,7 +9,7 @@
  * 2: Filter function returning true for valid vehicles <FUNC> (Optional)
  *
  * Return Value:
- * None
+ * Nearest vehicle or objNull if not found <OBJECT>
  *
  * Example:
  * [player] call afsk_civilian_fnc_getNearestVehicle

diff --git a/addons/civilian/functions/fnc_initCivilian.sqf b/addons/civilian/functions/fnc_initCivilian.sqf
@@ -35,3 +35,5 @@ _civilian addEventHandler ["Killed", {
 [_civilian, _cityNamespace] call FUNC(assignCityCivilian);
 GVAR(civilians) pushBack _civilian;
 _civilian setVariable [QGVAR(initialized), true];
+
+_civilian
diff --git a/addons/common/functions/fnc_deleteAtRandom.sqf b/addons/common/functions/fnc_deleteAtRandom.sqf
@@ -17,4 +17,4 @@
 
 params ["_array"];
 
-_array deleteAt (floor (random (count _array)));
+_array deleteAt (floor (random (count _array)))
diff --git a/addons/common/functions/fnc_getNearestLocationName.sqf b/addons/common/functions/fnc_getNearestLocationName.sqf
@@ -30,4 +30,4 @@ if (_pos isEqualType objNull) then {
 private _nearestLocation = [_pos, _searchRadius] call FUNC(getNearestLocationWithAvailableName);
 if (_nearestLocation isEqualTo locationNull) exitWith {""};
 
-[_nearestLocation] call FUNC(getLocationName);
+[_nearestLocation] call FUNC(getLocationName)
diff --git a/addons/common/functions/fnc_getRandomPos.sqf b/addons/common/functions/fnc_getRandomPos.sqf
@@ -63,4 +63,4 @@ while {(_loopLimit >= 0) && {(_randomPos isEqualTo [])}} do {
 
 if (_loopLimit isEqualTo 0) exitWith {[]};
 
-_randomPos;
+_randomPos
diff --git a/addons/common/functions/fnc_getTextFromConfig.sqf b/addons/common/functions/fnc_getTextFromConfig.sqf
@@ -7,7 +7,7 @@
  * None
  *
  * Return Value:
- * None
+ * Text read from config <STRING>
  *
  * Example:
  * None

diff --git a/addons/common/functions/fnc_showMessage.sqf b/addons/common/functions/fnc_showMessage.sqf
@@ -23,4 +23,6 @@ if (GVAR(ACE_Loaded)) then {
     [_msg, _size, _target, _width] call ACE_common_fnc_displayTextStructured;
 } else {
     hint _msg;
-}
+};
+
+nil
diff --git a/addons/jail/functions/fnc_canRelease.sqf b/addons/jail/functions/fnc_canRelease.sqf
@@ -8,7 +8,7 @@
  * 1: Unit to release <OBJECT>
  *
  * Return Value:
- * None
+ * Whether target unit can be released <BOOL>
  *
  * Example:
  * [bob, ted] call afsk_jail_fnc_canBeReleased

diff --git a/addons/jail/functions/fnc_getRandomJailPos.sqf b/addons/jail/functions/fnc_getRandomJailPos.sqf
@@ -15,4 +15,4 @@
  * Public: No
  */
 
-[[[getPosATL GVAR(jail), GVAR(jail) getVariable "objectArea"]], ["water"]] call BIS_fnc_randomPos;
+[[[getPosATL GVAR(jail), GVAR(jail) getVariable "objectArea"]], ["water"]] call BIS_fnc_randomPos
diff --git a/addons/killers/functions/fnc_anyKillerFree.sqf b/addons/killers/functions/fnc_anyKillerFree.sqf
@@ -7,7 +7,7 @@
  * None
  *
  * Return Value:
- * None
+ * True if any killer is still free <BOOL>
  *
  * Example:
  * call afsk_killers_fnc_anyKillerFree

diff --git a/addons/modules/functions/fnc_initKillersStarts.sqf b/addons/modules/functions/fnc_initKillersStarts.sqf
@@ -7,7 +7,7 @@
  * None
  *
  * Return Value:
- * None
+ * List of killers start modules <ARRAY<OBJECT>>
  *
  * Example:
  * None

diff --git a/addons/modules/functions/fnc_initKillersStashes.sqf b/addons/modules/functions/fnc_initKillersStashes.sqf
@@ -7,7 +7,7 @@
  * None
  *
  * Return Value:
- * None
+ * List of killers stash modules <ARRAY<OBJECT>>
  *
  * Example:
  * None

diff --git a/addons/modules/functions/fnc_initPoliceStations.sqf b/addons/modules/functions/fnc_initPoliceStations.sqf
@@ -7,7 +7,7 @@
  * None
  *
  * Return Value:
- * None
+ * List of police station modules <ARRAY<OBJECT>>
  *
  * Example:
  * None

diff --git a/addons/score/functions/fnc_addPoliceScore.sqf b/addons/score/functions/fnc_addPoliceScore.sqf
@@ -39,3 +39,5 @@ GVAR(policeScoreLastChangeTime) = CBA_missionTime;
         publicVariable QGVAR(policeScoreChange);
     };
 }, [GVAR(policeScoreChange)], 5] call CBA_fnc_waitAndExecute;
+
+GVAR(policeScore)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,4 +17,4 @@

		params ["_array"];

		_array deleteAt (floor (random (count _array)));
		_array deleteAt (floor (random (count _array)))
Original file line number	Diff line number	Diff line change
Expand Up		@@ -63,4 +63,4 @@ while {(_loopLimit >= 0) && {(_randomPos isEqualTo [])}} do {

		if (_loopLimit isEqualTo 0) exitWith {[]};

		_randomPos;
		_randomPos
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ @@
      * None
      *
      * Return Value:
-     * None
+     * Text read from config <STRING>
      *
      * Example:
      * None
@@ Expand Down @@