Arma3_Epoch/ACE3
1
0
Fork 0
mirror of https://github.com/acemod/ACE3.git synced 2024-08-30 18:23:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve function header documentation guidelines (#6042)

Browse Source
This commit is contained in:
Thomas Müller 2018-01-11 19:34:51 +01:00 committed by SilentSpike
parent a5523bc0c7
commit fc037d1bc3
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/wiki/development/coding-guidelines.md
View File

@ -178,6 +178,10 @@ Every function should have a header of the following format as the start of thei
* Arguments:
* 0: The first argument <STRING>
* 1: The second argument <OBJECT>
* 2: Multiple input types <STRING|ARRAY|CODE>
* 3: Optional input <BOOL> (default: true)
* 4: Optional input with multiple types <CODE|STRING> (default: {true})
* 5: Not mandatory input <STRING> (default: nil)
*
* Return Value:
* The return value <BOOL>