Documentation -- Function Headers -- sys_prc343 #110

TheMagnetar · 2016-11-29T13:15:21Z

When merged this pull request will:

Handle documentation issue Documentation - Complete all function headers #107: sys_prc343 component. WIP.

jonpas

No semi-colons in header examples.

jonpas · 2017-02-16T15:44:33Z

addons/sys_prc343/radio/fnc_closeGui.sqf

 *
 * Return Value:
- * RETURN VALUE <TYPE>
+ * true <BOOL>


True <BOOL>

jonpas · 2017-02-16T15:45:08Z

addons/sys_prc343/radio/fnc_getCurrentChannel.sqf

 *
 * Return Value:
- * RETURN VALUE <TYPE>
+ * Current channel id <NUMBER>


jonpas · 2017-02-16T15:45:24Z

addons/sys_prc343/radio/fnc_getCurrentChannel.sqf

- * 0: ARGUMENT ONE <TYPE>
- * 1: ARGUMENT TWO <TYPE>
+ * 0: Radio ID <STRING>
+ * 1: Event (Unused) <STRING>


<STRING> (Unused) move unused to end.

jonpas · 2017-02-16T15:45:30Z

addons/sys_prc343/radio/fnc_getCurrentChannel.sqf

- * 1: ARGUMENT TWO <TYPE>
+ * 0: Radio ID <STRING>
+ * 1: Event (Unused) <STRING>
+ * 2: Event data (Unused) <NUMBER>


Move unused to end.

jonpas · 2017-02-16T15:45:41Z

addons/sys_prc343/radio/fnc_getChannelData.sqf

 *
 * Arguments:
- * 0: ARGUMENT ONE <TYPE>
- * 1: ARGUMENT TWO <TYPE>
+ * 0: Radio ID (Unused) <STRING>


Move unused to end.

jonpas · 2017-02-16T15:46:20Z

addons/sys_prc343/radio/fnc_getChannelDescription.sqf

 *
 * Arguments:
- * 0: ARGUMENT ONE <TYPE>
- * 1: ARGUMENT TWO <TYPE>
+ * 0: Radio ID <STRING>


Add the unused ones.

jonpas · 2017-02-16T15:46:49Z

addons/sys_prc343/radio/fnc_closeGui.sqf

- * 0: ARGUMENT ONE <TYPE>
- * 1: ARGUMENT TWO <TYPE>
+ * 0: Radio ID (Unused) <STRING>
+ * 1: Event with the value "getChannelData" (Unused) <STRING>


Move unused to end.

jonpas · 2017-02-16T15:46:52Z

addons/sys_prc343/radio/fnc_closeGui.sqf

- * 1: ARGUMENT TWO <TYPE>
+ * 0: Radio ID (Unused) <STRING>
+ * 1: Event with the value "getChannelData" (Unused) <STRING>
+ * 2: Event data with the channel number (Unused) <NUMBER>


Move unused to end.

jonpas · 2017-02-16T15:46:56Z

addons/sys_prc343/radio/fnc_closeGui.sqf

+ * 0: Radio ID (Unused) <STRING>
+ * 1: Event with the value "getChannelData" (Unused) <STRING>
+ * 2: Event data with the channel number (Unused) <NUMBER>
+ * 3: Radio data (Unused) <HASH>


Move unused to end.

jonpas · 2017-02-16T15:47:05Z

addons/sys_prc343/radio/fnc_closeGui.sqf

@@ -1,16 +1,18 @@
 /*
 * Author: ACRE2Team
- * SHORT DESCRIPTION
+ * Close radio GUI when calling this function. Event rised by onUnload (PRC343_RadioDialog).


raised, no when calling this function, that's rather obvious.

TheMagnetar · 2017-02-16T17:16:59Z

Sorry I should have uploaded the changes.

jonpas · 2017-02-27T16:29:20Z

addons/sys_prc343/functions/fnc_onChannelKnobPress.sqf

@@ -10,7 +10,7 @@
 * RETURN VALUE <TYPE>
 *
 * Example:
- * [ARGUMENTS] call acre_COMPONENT_fnc_FUNCTIONNAME
+ * [ARGUMENTS] call acre_sys_prc343_fnc_onChannelKnobPress;


Still no semi-colons. :)

jonpas · 2017-03-01T22:28:54Z

addons/sys_prc343/functions/fnc_render.sqf

@@ -1,16 +1,15 @@
 /*
 * Author: ACRE2Team
- * SHORT DESCRIPTION
+ * Renders the radio when opened


Missing final dot.

jonpas · 2017-03-01T22:29:02Z

addons/sys_prc343/functions/fnc_render.sqf

 *
 * Example:
- * [ARGUMENTS] call acre_sys_prc343_fnc_render;
+ * [DisplazID] call acre_sys_prc343_fnc_render


Y instead of Z.

jonpas · 2017-03-01T22:29:19Z

addons/sys_prc343/functions/fnc_zoomChannelBlockSelector.sqf

 *
 * Arguments:
- * 0: ARGUMENT ONE <TYPE>
+ * 0: Zoom in(0) or out (1) <BOOL>


Space after in.

jonpas · 2017-03-01T22:30:41Z

addons/sys_prc343/radio/fnc_getCurrentChannelInternal.sqf

@@ -1,19 +1,15 @@
 /*
 * Author: ACRE2Team
- * SHORT DESCRIPTION
+ * Returns the unique identity of the current channel since the PRC343 has multiple blocks


Missing final dot.

TheMagnetar · 2017-03-02T07:08:57Z

I will test it later in the day since this PR also introduces params of the form: params ["_radioId", "", "", "", ""];

TheMagnetar · 2017-03-02T17:29:44Z

I tested this and it should be ready to be merged.

* Use code block for mods list in issue template * Hide radio self-interaction node if no radio in inventory * Introduce Variable to deactivated distance-based muting (#228) * Order radio ear left/right correctly * Cleanup and macros (#230) * Delete unused traces * QEFUNC Macro * Moved all opening braces on same line * Removed spaced after classes * Spaces and Indentation * More spaces * Fix direct speech page vehicle attenuation link * Add Custom Signal Processing wiki page to sidebar, Cleanup sidebar config * Use ACE3 notification if available instead of hint (#239) * Add displayNotification function * Fix log * Pass functions 'by reference' to BI evenEHs * acre_api_fnc_setCustomSignalFunc - reset fix (#227) * fixes the possibility to reset the function to default behavior * wrong term * lowercase if * Update documentation * Use of ICON_RADIO_CALL in ace_interact * Fix ctrSetEventHandler. Back to Quotes as in #241 (#243) Fix ctrlSetEventHandler - back to quotes as in #241 * Fixes the antenna direction calculation (#233) * Improve mod listing on issue template * Update easylogging++ to v9.94.1 (#246) * Update easylogging++ to v9.94.1, Bandaid prevent default log file from creation * Include easylogging++.cc in CMake, Change max file size to 1 MB * Hotfix muting variable (#248) * Fix duplicate ID handling (#251) * Fix acre failing initialise due to a race condition (#240) * Documentation -- Function Headers -- sys_prc343 (#110) * Changed function example calls * Headers 1 * Completed headers. Missing arguments * Improvements on Doc * Review changes * v2.4.0.943 - Build 37 * Use CBA Namespaces * 4nec2 Antenna Calculation (#244) - Switches Antenna Calculation from MMANA-GAL to 4NEC2 (Closes #201) - Converts all existing antenna data files to 4NEC2 ones - Adds additional antennas for e.g SEM52 (Closes #29) - Introduces a new script to convert 4NEC2 output files to ACRE's `*.aba` file * SEM70 (#199) Adds a new radio: SEM70, a manpack radio used by German Armed Forces. It comes with an UI, rendered in 3D like all other ACRE2 radios. Model and textures created by Raspu (https://github.com/Raspu86). Additionally it is the first radio featuring an automatic channel selection. Details will follow in the documentation. * Fixes * Fix duplicate mounted radios in racks * Infantry Phone (#224) * External intercom * Handle dead units using the intercom * Some requested changes * Lunch break fixes * Changes all references of external Intercom to Infantry Phone * DOC: Infantry telephone * Macroize interactions, Fix missing string * Add actions dynamically, Add support for custom position/selection * Improve things * Add vanilla Tanks and Tracker APCs custom positions, Disable debug * Fix in vehicle checks * Revert some changes from previous commit * Moved to sys_intercom * Call functionality implemented * Fix the spalling of own name * Fixes of example calls * Fix headers, Use clientInit postInit * Move intercom/infantry phone config to vehicle root class * Changed true/false to 1/0 in configs * Cleanup configs, Don't attach init EH if ACE3 disabled * Add vehicle intercom and infantry phone documentation * Use ACE3 notifications, Cleanup minor things * Added ringing description * Add additional line regarding ringing position in framework doc * Use displayNotification * Fix issue * Fix stupidity... * Fix displayNotification * Add infantry phone connected message * PhoneCall fixes * Remove of duplicate private * Prevent destroyed vehicle beeping and infantry phone interaction * Stop infantry phone from beeping if no crew members are aboard * Doc and lazy evaluation * HCs are kind of important * No need for code in code * Redefined infantry phone position for compatibility with other mods * Fix: sound in all clients * Fixed intercom * remoteExecCall to CBA_fnc_globalEvent * Privatising * inline functions though, yuck * Updated documentation * Fix SEM70 (#257) - Frequency default (stupid) - PBOPrefix was ooold - Disable Debugging * Use CBA Namespaces * v2.4.0.944 - Build 38 * Update Documentation Theme (#253) * Add url to branching image, Put --incremental guideline as optional * Update Jekyll Documentation Theme to 06dc9e0e257e014d1ccf9de158e76a61d74f84e6 * Remove redundant tooltips files, Fix search * Use url from file location by default for images * Renamed settings variables (#259) * Teamspeak channel switching functionality (#225) * Initial commit for channel move functionality * Changes as per previous review * Request changes and improvements * Fixed incorrect use of EGVAR * Requested changes. Normalised name to TS3 and normalised formatting. * Improved name search utilising Levenshtein distance * Whitespace * Requested changes * Whitespaceroni * Requested changes * Removed comment from pipe timeout * Use display XEH instead of PFH * Add missing checks in display XEH * Removes extra include causing make error (#261) * Removes extra include causing make error * There was another one as well... * Use custom namespace for Fast Hashes (#267) * Use custom location with invalid drawStyle for fast hashes to improve performance * Fully move hashes to sys_core * Move the rest of fast hashes to sys_core, Fix crash in PREP * Prefix global fast hash variables * Remove redundant code * Fix missing renames * Move all fast hash stuff to main * Create menu hashes before using them * Return Menu hashes to working location * Cleanup 117f and 152 menus compilation (don't run in preStart) * Use custom namespace for Fast Hashes (#267) * Use custom location with invalid drawStyle for fast hashes to improve performance * Fully move hashes to sys_core * Move the rest of fast hashes to sys_core, Fix crash in PREP * Prefix global fast hash variables * Remove redundant code * Fix missing renames * Move all fast hash stuff to main * Create menu hashes before using them * Return Menu hashes to working location * Cleanup 117f and 152 menus compilation (don't run in preStart) * v2.4.0.945 - Build 39 * v2.4.0.946 - Build 6 * Actually increment patch version * v2.4.1.947 - Build 7 * Polish translation. (#268) Polish translation * Box with radios (#265) * Box with radios * Requested changes * Added forgotten displayName * Added box to units[] in CfgPatches * Rename tag, lower amount of radios, more small radios than big radios * Clean-up and document to sys_io (#249) * Some improvements to sys_io * Improve mentions of the extension. * Improve comments * Added SEM70 to main readme (#270) * External radios (#214) * First implementation of external radios * Fixes, vehicles added and tweaked availability of ace actions * Fixes * Fixes and remove debug * Fixes and improvements * Fixed vehicles * Updated german translations * Improved ace interaction actions * Fixed Doc * Prevent the use of an external radio if it is already in use * PR requested changes * Additional fixes * Moved ace_interaction related functions to sys_external * Update notifications and use of icon macro * Removed extra semicolons * Hide entry if no radios are shared externally * Allow players to give the radio headsets to other units * Radio owner awareness * Requested changes * Requested changes and documentation * Adding new page to sidebar * Fix doc entry in side-bar * Fixes * Removed tabs at the end of line * Set external radio as active and improve messages * Fixed display messages * Prevent action from showing if distance is too large * Requested changes * Tabs tabs tabs. those hateful tabs * Forgetful magnetar * Forgetful magnetar. Part 2. * Further optimisations * Intercom overhaul and passenger intercom (#255) * External intercom * Handle dead units using the intercom * Some requested changes * Lunch break fixes * Changes all references of external Intercom to Infantry Phone * DOC: Infantry telephone * Macroize interactions, Fix missing string * Add actions dynamically, Add support for custom position/selection * Improve things * Add vanilla Tanks and Tracker APCs custom positions, Disable debug * Fix in vehicle checks * Revert some changes from previous commit * Moved to sys_intercom * Call functionality implemented * Fix the spalling of own name * Fixes of example calls * Fix headers, Use clientInit postInit * Move intercom/infantry phone config to vehicle root class * Changed true/false to 1/0 in configs * Cleanup configs, Don't attach init EH if ACE3 disabled * Add vehicle intercom and infantry phone documentation * Use ACE3 notifications, Cleanup minor things * Added ringing description * Add additional line regarding ringing position in framework doc * Use displayNotification * Fix issue * Fix stupidity... * Fix displayNotification * Add infantry phone connected message * PhoneCall fixes * Remove of duplicate private * Prevent destroyed vehicle beeping and infantry phone interaction * Stop infantry phone from beeping if no crew members are aboard * Doc and lazy evaluation * HCs are kind of important * No need for code in code * Redefined infantry phone position for compatibility with other mods * First implementation * Fix: sound in all clients * Fixed intercom * Fixes for passenger intercom * cba_fnc_globalEvent instead of remoteExecCall * Requested changes * Requested changes II * Intercom overhaul and passenger intercom * CBA settings and network optimisations * Fixed: prevent from connecting to passenger intercom when the phone is ringing * Fixes and corner cases * BLUFOR vehicles * Fixed attenuation checks * Helicopters, SDVs and VTOLS * Added hook for custom actions on Inf. phone change status * Documentation formatting issues * Update Documentation * Don't use negation * Fixes + doc * Remove debug comment * Requested changes * Removed fnc_intercomActions.sqf since it was no longer needed * Optimisations and noApiFunctions for debugging purposes * Improve config inheritance, Check event type * Passenger to Pax, Add note * Shorten Inf Phone strings * Formatting of ace actions and removal of switch intercom message * v2.4.1.948 - Build 40 * Fix Vehicle Intercom Framework documentation page * Formatting * TS3 channel switching documentation (#272) * Added TS3 channel switching documentation * Few grammar changes * Changes * Hash be gone * Empty lines * Russian translation (#278) * no message * PAX translations. * Power fixes and request changes

Changed function example calls

f98dbe5

Soldia1138 added cleanup documentation WIP labels Nov 29, 2016

Soldia1138 mentioned this pull request Nov 29, 2016

Documentation - Complete all function headers #107

Closed

jonpas modified the milestones: 2.3.0, 2.4.0 Nov 29, 2016

Merge branch 'master' into functionHeaders_PRC343

6d13e16

Sniperhid modified the milestones: 2.5.0, 2.4.0 Feb 5, 2017

Ferran Obón Santacana added 2 commits February 5, 2017 19:26

Merge branch 'master' into functionHeaders_PRC343

9a65911

Headers 1

df6b059

jonpas requested changes Feb 16, 2017

View reviewed changes

Completed headers. Missing arguments

8e4cdb7

jonpas requested changes Feb 27, 2017

View reviewed changes

Improvements on Doc

380d877

jonpas requested changes Mar 1, 2017

View reviewed changes

TheMagnetar added 2 commits March 2, 2017 07:59

Review changes

e61d7f3

Merge branch 'master' into functionHeaders_PRC343

ef0c412

TheMagnetar added the needs testing label Mar 2, 2017

TheMagnetar removed needs testing WIP labels Mar 2, 2017

jonpas approved these changes Mar 2, 2017

View reviewed changes

jonpas merged commit c427177 into IDI-Systems:master Mar 2, 2017

TheMagnetar deleted the functionHeaders_PRC343 branch March 2, 2017 18:08

jonpas modified the milestones: 2.4.1, 2.5.0 Mar 17, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation -- Function Headers -- sys_prc343 #110

Documentation -- Function Headers -- sys_prc343 #110

TheMagnetar commented Nov 29, 2016

jonpas left a comment

jonpas Feb 16, 2017

jonpas Feb 16, 2017

jonpas Feb 16, 2017

jonpas Feb 16, 2017

jonpas Feb 16, 2017

jonpas Feb 16, 2017

jonpas Feb 16, 2017

jonpas Feb 16, 2017

jonpas Feb 16, 2017

jonpas Feb 16, 2017

TheMagnetar commented Feb 16, 2017

jonpas Feb 27, 2017

jonpas Mar 1, 2017

jonpas Mar 1, 2017

jonpas Mar 1, 2017

jonpas Mar 1, 2017

TheMagnetar commented Mar 2, 2017

TheMagnetar commented Mar 2, 2017

Documentation -- Function Headers -- sys_prc343 #110

Documentation -- Function Headers -- sys_prc343 #110

Conversation

TheMagnetar commented Nov 29, 2016

jonpas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheMagnetar commented Feb 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheMagnetar commented Mar 2, 2017

TheMagnetar commented Mar 2, 2017