Merge branch 'master' of https://github.com/CBATeam/CBA_A3

CBATeam · May 30, 2016 · 5d66287 · 5d66287
2 parents 125699b + eeacf23
commit 5d66287
Show file tree

Hide file tree

Showing 14 changed files with 687 additions and 680 deletions.
diff --git a/addons/arrays/fnc_getArrayDiff.sqf b/addons/arrays/fnc_getArrayDiff.sqf
@@ -10,7 +10,7 @@ Parameters:
 Example:
     (begin example)
     _distance = [[0,0,1], [0,0,0]] call CBA_fnc_getArrayDiff
-    (end
+    (end example)
 
 Returns:
     Array Differences (for above example, return is [[1],[0]])

diff --git a/addons/network/fnc_globalExecute.sqf b/addons/network/fnc_globalExecute.sqf
@@ -1,8 +1,10 @@
 /*
 Function: CBA_fnc_globalExecute
 
-Description:
-    Executes code on given destinations. DEPRECATED. Use remoteExec instead.
+DEPRECATED. Use <remoteExec at https://community.bistudio.com/wiki/remoteExec> instead.
+
+Description
+    Executes code on given destinations.
 
 Parameters:
     _channel    - All: -2, ClientsOnly: -1, ServerOnly: 0 [Integer]

diff --git a/addons/network/fnc_globalSay.sqf b/addons/network/fnc_globalSay.sqf
@@ -1,8 +1,10 @@
 /*
 Function: CBA_fnc_globalSay
 
+DEPRECATED. Use <remoteExec at https://community.bistudio.com/wiki/remoteExec> ["say"] instead.
+
 Description:
-    Says sound on all client computer. DEPRECATED. Use remoteExec ["say"] instead.
+    Says sound on all client computer.
 
 Parameters:
     [_objects] - Array of Objects that perform Say [Object]

diff --git a/addons/network/fnc_globalSay3d.sqf b/addons/network/fnc_globalSay3d.sqf
@@ -1,8 +1,10 @@
 /*
 Function: CBA_fnc_globalSay3d
 
+DEPRECATED. Use <remoteExec at https://community.bistudio.com/wiki/remoteExec> ["say3D"] instead.
+
 Description:
-    Says sound on all client computer in 3d. DEPRECATED. Use remoteExec ["say3D"] instead.
+    Says sound on all client computer in 3D.
 
 Parameters:
     _object - Object that performs Say [Object] can also be _array - [object, targetObject]

diff --git a/addons/strings/fnc_substr.sqf b/addons/strings/fnc_substr.sqf
@@ -9,7 +9,7 @@ Description:
 Parameters:
     _string - String to extract from [String]
     _startIndex - Index to start the substring extraction [Number]
-    _length - length of the extracted substring [Number](Optinal) if is not set than from _startIndex to end
+    _length - length of the extracted substring [Number](Optional) if is not set than from _startIndex to end
 
 Returns:
     String extracted [String]

diff --git a/addons/strings/fnc_substring.sqf b/addons/strings/fnc_substring.sqf
@@ -6,8 +6,8 @@ Description:
 
 Parameters:
     _string - String to extract from [String]
-    _startIndex - Index to start the substring extraction [String]
-    _endIndex - Index to end the substring extraction [String]
+    _startIndex - Index to start the substring extraction [Number]
+    _endIndex - Index to end the substring extraction [Number]
 
 Returns:
     String extracted [String]

diff --git a/store/function_library.tar b/store/function_library.tar
diff --git a/tools/make_docs b/tools/make_docs
@@ -14,9 +14,22 @@ then
   mkdir ../docs
 fi
 cp overview.txt CBA_logo_large.png ../addons
+
+# Move the documented, but internal-only functions out of the way
+# while compiling the documentation
+cp -a ../addons/xeh /tmp/
+rm ../addons/xeh/*
+cp -a /tmp/xeh/fnc_addClassEventHandler.sqf ../addons/xeh
+cp -a /tmp/xeh/fnc_isRecompileEnabled.sqf ../addons/xeh
+cp -a /tmp/xeh/fnc_isScheduled.sqf ../addons/xeh
+
 $NATURALDOCS -r -i "../addons" -o HTML "../docs" -p "ndocs-project" -s Default cba
 rm ../addons/{overview.txt,CBA_logo_large.png}
 
+# Restore xeh
+cp -a /tmp/xeh/* ../addons/xeh/
+rm -rf /tmp/xeh
+
 echo -e "\n=== Packaging documentation ===\n"
 rm -f ../store/function_library.tar
 fakeroot tar -C ../ -cf ../store/function_library.tar docs

diff --git a/tools/ndocs-project/Data/ConfigFileInfo.nd b/tools/ndocs-project/Data/ConfigFileInfo.nd
diff --git a/tools/ndocs-project/Data/FileInfo.nd b/tools/ndocs-project/Data/FileInfo.nd
diff --git a/tools/ndocs-project/Data/ImageFileInfo.nd b/tools/ndocs-project/Data/ImageFileInfo.nd
diff --git a/tools/ndocs-project/Data/PreviousMenuState.nd b/tools/ndocs-project/Data/PreviousMenuState.nd
diff --git a/tools/ndocs-project/Data/SymbolTable.nd b/tools/ndocs-project/Data/SymbolTable.nd
diff --git a/tools/ndocs-project/Menu.txt b/tools/ndocs-project/Menu.txt