Merge pull request #3944 from acemod/funcHeaders

Cleanup Function Headers Titles

addons/advanced_ballistics/functions/fnc_displayProtractor.sqf

@@ -3,10 +3,10 @@
  *
  * Displays a protractor in the top left corner of the screen
  *
- * Argument:
+ * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/attach/functions/fnc_getChildrenAttachActions.sqf

@@ -3,11 +3,11 @@
  * Show the ammo counts for a static weapon.
  * Called from "insertChildren" on interact_menu
  *
- * Argument:
+ * Arguments:
  * 0: Target <OBJECT>
  * 1: Player <OBJECT>
  *
- * Return value:
+ * Return Value:
  * ChildActiosn<ARRAY>
  *
  * Example:

addons/cargo/functions/fnc_canLoad.sqf

@@ -6,7 +6,7 @@
  * 0: Player <OBJECT>
  * 1: Object to load <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Can load <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_canLoadItemIn.sqf

@@ -6,7 +6,7 @@
  * 0: Item <OBJECT or STRING>
  * 1: Holder Object (Vehicle) <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Can load in <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_canUnloadItem.sqf

@@ -7,7 +7,7 @@
  * 1: Object <OBJECT>
  * 2: Unloader (player) <OPTIONAL><OBJECT>
  *
- * Return value:
+ * Return Value:
  * Can be unloaded <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_findNearestVehicle.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Unit <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Vehicle in Distance <OBJECT>
  *
  * Example:

addons/cargo/functions/fnc_getCargoSpaceLeft.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Cargo space left <NUMBER>
  *
  * Example:

addons/cargo/functions/fnc_getSizeItem.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Item <OBJECT or STRING>
  *
- * Return value:
+ * Return Value:
  * Cargo size <NUMBER> (default: -1)
  *
  * Example:

addons/cargo/functions/fnc_handleDestroyed.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/cargo/functions/fnc_initObject.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/cargo/functions/fnc_loadItem.sqf

@@ -7,7 +7,7 @@
  * 0: Item <OBJECT or STRING>
  * 1: Vehicle <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Object loaded <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_makeLoadable.sqf

@@ -7,7 +7,7 @@
  * 1: Set as loadable (default: true) <BOOL><SCALAR>
  * 2: Size. (default: 1) <NUMBER>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/cargo/functions/fnc_onMenuOpen.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Display <DISPLAY>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/cargo/functions/fnc_startLoadIn.sqf

@@ -6,7 +6,7 @@
  * 0: Player <OBJECT>
  * 1: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Load ProgressBar Started <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_startUnload.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/cargo/functions/fnc_unloadItem.sqf

@@ -6,7 +6,7 @@
  * 0: Item <OBJECT or STRING>
  * 1: Vehicle <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Object unloaded <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_validateCargoSpace.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/common/functions/fnc_codeToString.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Code <CODE, STRING>
  *
- * Return value:
+ * Return Value:
  * Code <STRING>
  *
  * Public: Yes

addons/common/functions/fnc_dropBackpack.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Unit that has a backpack <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Ground wepaon holder with backpack <OBJECT>
  *
  * Public: Yes

addons/common/functions/fnc_firedEH.sqf

@@ -2,7 +2,7 @@
  * Author: esteldunedain
  * Unfied handling of weapon fire
  *
- * Argument:
+ * Arguments:
  * 0: unit - Object the event handler is assigned to <OBJECT>
  * 1: weapon - Fired weapon <STRING>
  * 2: muzzle - Muzzle that was used <STRING>
@@ -11,7 +11,7 @@
  * 5: magazine - magazine name which was used <STRING>
  * 6: projectile - Object of the projectile that was shot <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/common/functions/fnc_fixPosition.sqf

@@ -3,7 +3,7 @@
  *
  * Fixes position of an object. E.g. moves object above ground and adjusts to terrain slope. Requires local object.
  *
- * Argument:
+ * Arguments:
  * Object <OBJECT>
  *
  * Return Value:

addons/common/functions/fnc_getMGRSdata.sqf

@@ -4,7 +4,7 @@
  * Also gets longitude, latitude and altitude offset for the map.
  * Writes return values to GVAR(MGRS_data) if run on the current map.
  *
- * Argument:
+ * Arguments:
  * 0: Map name (default: worldName) <STRING>
  *
  * Return Value:

addons/common/functions/fnc_getMapData.sqf

@@ -2,7 +2,7 @@
  * Author: VKing, bux
  * Gets the current latitude and altitude offset for the map.
  *
- * Argument:
+ * Arguments:
  * 0: Map name (default: worldName) <STRING>
  *
  * Return Value:

addons/common/functions/fnc_isInBuilding.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Unit <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Is the unit in a building? <BOOL>
  *
  * Public: Yes

addons/common/functions/fnc_monitor.sqf

@@ -2,7 +2,7 @@
  * Author: commy2
  * hint retun value of given function every frame
  *
- * Argument:
+ * Arguments:
  * <CODE>
  *
  * Return Value:

addons/common/functions/fnc_runAfterSettingsInit.sqf

@@ -2,11 +2,11 @@
  * Author: PabstMirror
  * Executes code after setting are initilized.
  *
- * Argument:
+ * Arguments:
  * 0: Code to execute <CODE>
  * 1: Parameters to run the code with <ANY>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/common/functions/fnc_setApproximateVariablePublic.sqf

@@ -2,13 +2,13 @@
  * Author: esteldunedain
  * Publish a variable if it's different enough from the previously published value.
  *
- * Argument:
+ * Arguments:
  * 0: Object the variable should be assigned to <OBJECT>
  * 1: Name of the variable <STRING>
  * 2: Value of the variable <ANY>
  * 3: Absolute tolerance <NUMBER>
  *
- * Return value:
+ * Return Value:
  * Nothing.
  *
  * Example:

addons/common/functions/fnc_setVariablePublic.sqf

@@ -2,13 +2,13 @@
  * Author: commy2 and CAA-Picard and joko and PabstMirror
  * Publish a variable, but wait a certain amount of time before allowing it to be published it again.
  *
- * Argument:
+ * Arguments:
  * 0: Object the variable should be assigned to <OBJECT>
  * 1: Name of the variable <STRING>
  * 2: Value of the variable <ANY>
  * 3: Embargo delay <NUMBER> (Optional. Default: 1)
  *
- * Return value:
+ * Return Value:
  * Nothing.
  *
  * Example:

addons/common/functions/fnc_showUser.sqf

@@ -2,7 +2,7 @@
  * Author: commy2
  * hint the Variable ACE_isUsedBy from the input Object every frame
  *
- * Argument:
+ * Arguments:
  * <OBJECT>
  *
  * Return Value:

addons/common/functions/fnc_waitUntilAndExecute.sqf

@@ -2,12 +2,12 @@
  * Author: joko // Jonas
  * Executes a code once with after the Condition is True, using a PFH
  *
- * Argument:
+ * Arguments:
  * 0: Condition <CODE>
  * 1: Code to execute <CODE>
  * 2: Parameters to run the code with <ARRAY,ANY,NIL>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/dragging/functions/fnc_initObject.sqf

@@ -2,7 +2,7 @@
  * Author: commy2
  * Initialize variables for drag or carryable objects. Called from init EH.
  *
- * Argument:
+ * Arguments:
  * 0: Any object <OBJECT>
  *
  * Return Value:

addons/dragging/functions/fnc_initPerson.sqf

@@ -2,10 +2,10 @@
  * Author: commy2
  * Initialize variables for drag or carryable persons. Called from init EH.
  *
- * Argument:
+ * Arguments:
  * 0: Unit <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/dragging/functions/fnc_isObjectOnObject.sqf

@@ -2,10 +2,10 @@
  * Author: commy2
  * Check if Object is Overlapping
  *
- * Argument:
+ * Arguments:
  * 0: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * <BOOL>
  *
  * Example;

addons/dragging/functions/fnc_setCarryable.sqf

@@ -2,7 +2,7 @@
  * Author: commy2
  * Enable the object to be carried.
  *
- * Argument:
+ * Arguments:
  * 0: Any object <OBJECT>
  * 1: true to enable carrying, false to disable <BOOL>
  * 2: Position offset for attachTo command <ARRAY> (default: [0,1,1])

addons/dragging/functions/fnc_setDraggable.sqf

@@ -2,13 +2,13 @@
  * Author: commy2
  * Enable the object to be dragged.
  *
- * Argument:
+ * Arguments:
  * 0: Any object <OBJECT>
  * 1: true to enable dragging, false to disable <BOOL>
  * 2: Position offset for attachTo command (Array, optinal; default: [0,0,0])
  * 3: Direction in degree to rotate the object after attachTo (Number, optional; default: 0)
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/dragging/functions/fnc_startDrag.sqf

@@ -2,11 +2,11 @@
  * Author: commy2
  * Start the dragging process.
  *
- * Argument:
+ * Arguments:
  * 0: Unit that should do the dragging <OBJECT>
  * 1: Object to drag <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/fcs/functions/fnc_calculateSolution.sqf

@@ -8,7 +8,7 @@
  * 2: Target distance
  * 3: Azimuth offset
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No