Tools - Fix header arg types (#9752)

Fix header arg types
acemod · Jan 22, 2024 · 7e255bf · 7e255bf
1 parent d8961c6
commit 7e255bf
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 8 deletions.
diff --git a/addons/ai/functions/fnc_garrison.sqf b/addons/ai/functions/fnc_garrison.sqf
@@ -7,8 +7,8 @@
  * 0: The building(s) nearest this position are used <POSITION>
  * 1: Limit the building search to those type of building <ARRAY>
  * 2: Units that will be garrisoned <ARRAY>
- * 3: Radius to fill building(s) <SCALAR> (default: 50)
- * 4: 0: even filling, 1: building by building, 2: random filling <SCALAR> (default: 0)
+ * 3: Radius to fill building(s) <NUMBER> (default: 50)
+ * 4: 0: even filling, 1: building by building, 2: random filling <NUMBER> (default: 0)
  * 5: True to fill building(s) from top to bottom <BOOL> (default: false) (note: only works with filling mode 0 and 1)
  * 6: Teleport units <BOOL> (default: false)
 

diff --git a/addons/arsenal/functions/fnc_handleActions.sqf b/addons/arsenal/functions/fnc_handleActions.sqf
@@ -7,7 +7,7 @@
  * Arguments:
  * 0: Arsenal display <DISPLAY>
  * 1: Current panel control <CONTROL>
- * 2: Current panel selection <SCALAR>
+ * 2: Current panel selection <NUMBER>
  * 3: Item config entry <CONFIG>
  *
  * Return Value:

diff --git a/addons/common/functions/fnc_getWeight.sqf b/addons/common/functions/fnc_getWeight.sqf
@@ -5,7 +5,7 @@
  *
  * Arguments:
  * 0: The Unit (usually the player) <OBJECT>
- * 1: Force a return type <SCALAR, BOOLEAN>
+ * 1: Force a return type <NUMBER, BOOLEAN>
  *
  * Return Value:
  * The return value <NUMBER>

diff --git a/addons/medical_status/functions/fnc_addMedicationAdjustment.sqf b/addons/medical_status/functions/fnc_addMedicationAdjustment.sqf
@@ -7,10 +7,10 @@
  * 0: The Unit <OBJECT>
  * 1: Medication <STRING>
  * 2: Time in system for the adjustment to reach its peak <NUMBER>
- * 3: Duration the adjustment will have an effect <NUMVER>
- * 4: Heart Rate Adjust <NUMVER>
- * 5: Pain Suppress Adjust <NUMVER>
- * 6: Flow Adjust <NUMVER>
+ * 3: Duration the adjustment will have an effect <NUMBER>
+ * 4: Heart Rate Adjust <NUMBER>
+ * 5: Pain Suppress Adjust <NUMBER>
+ * 6: Flow Adjust <NUMBER>
  *
  * Return Value:
  * None

diff --git a/docs/tools/document_functions.py b/docs/tools/document_functions.py
@@ -192,6 +192,9 @@ def process_arguments(self, raw):
                 if arg_default is None:
                     arg_default = ""
 
+                if ("SCALAR" in arg_types or "NUMVER" in arg_types):
+                    self.feedback("Bad Arg Type \"{}\"".format(arg_types), 1)
+
                 arguments.append([arg_index, arg_name, arg_types, arg_default, arg_notes])
             else:
                 # Notes about the above argument won't start with an index