Fix doc generator not finding arguments across multiple lines + refac…

…tor how multiple possible types are documented and displayed in the docs + add new libraries, enums and classes + change capitalization to better follow own conventions

.gitignore

@@ -107,3 +107,7 @@ game/experiment/cfg/settings.scr
 
 # mkdocs/mkdocs-material
 .cache
+
+# mkdocs site or temp storage for speeding up test builds of mkdocs
+site/
+temp/

docs/classes/Angle/Add.md

@@ -14,8 +14,12 @@ lua:
   description: "Modifies the existing angle, adding another angle to it."
 
   arguments:
-    - name: "angle2"
-      type: Angle
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "angle2"
+    type: Angle
   returns:
     - type: Angle
       description: "The added angle."

docs/classes/Angle/Divide.md

@@ -14,8 +14,12 @@ lua:
   description: "Modifies the existing angle, dividing it by a number."
 
   arguments:
-    - name: "divideBy"
-      type: number
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "divideBy"
+    type: number
   returns:
     - type: Angle
       description: "The divided angle."

docs/classes/Angle/Forward.md

@@ -13,7 +13,10 @@ lua:
   realm: shared
   description: "Returns the forward vector of the angle."
 
-
+  arguments:
+  - position: 1
+    name: "angle"
+    type: Angle
   returns:
     - type: Vector
       description: "The forward vector of the angle."

docs/classes/Angle/Initialize.md

@@ -14,12 +14,18 @@ lua:
   description: "Initializes the angle with the specified values."
 
   arguments:
-    - name: "x"
-      type: number
-    - name: "y"
-      type: number
-    - name: "z"
-      type: number
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "x"
+    type: number
+  - position: 3
+    name: "y"
+    type: number
+  - position: 4
+    name: "z"
+    type: number
   returns:
     - type: Angle
       description: "The initialized angle."

docs/classes/Angle/Invalidate.md

@@ -13,7 +13,10 @@ lua:
   realm: shared
   description: "Makes the angle invalid."
 
-
+  arguments:
+  - position: 1
+    name: "angle"
+    type: Angle
   returns:
     - type: Angle
       description: "The invalidated angle."

docs/classes/Angle/IsEqualWithTolerance.md

@@ -14,10 +14,15 @@ lua:
   description: "Checks if the angle is equal to another angle within a tolerance."
 
   arguments:
-    - name: "other"
-      type: Angle
-    - name: "tolerance"
-      type: number
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "other"
+    type: Angle
+  - position: 3
+    name: "tolerance"
+    type: number
   returns:
     - type: boolean
       description: "True if the angles are equal within the tolerance, false otherwise."

docs/classes/Angle/IsValid.md

@@ -13,7 +13,10 @@ lua:
   realm: shared
   description: "Checks if the angle is valid."
 
-
+  arguments:
+  - position: 1
+    name: "angle"
+    type: Angle
   returns:
     - type: boolean
       description: "True if the angle is valid, false otherwise."

docs/classes/Angle/Length.md

@@ -13,7 +13,10 @@ lua:
   realm: shared
   description: "Returns the length of the angle."
 
-
+  arguments:
+  - position: 1
+    name: "angle"
+    type: Angle
   returns:
     - type: number
       description: "The length of the angle."

docs/classes/Angle/LengthSqr.md

@@ -13,7 +13,10 @@ lua:
   realm: shared
   description: "Returns the squared length of the angle."
 
-
+  arguments:
+  - position: 1
+    name: "angle"
+    type: Angle
   returns:
     - type: number
       description: "The squared length of the angle."

docs/classes/Angle/Normalize.md

@@ -13,7 +13,10 @@ lua:
   realm: shared
   description: "Modifies the existing angle, normalizing it between -180 to 180 degrees pitch, yaw and roll."
 
-
+  arguments:
+  - position: 1
+    name: "angle"
+    type: Angle
   returns:
     - type: Angle
       description: "The same angle, now normalized."

docs/classes/Angle/Right.md

@@ -13,7 +13,10 @@ lua:
   realm: shared
   description: "Returns the right vector of the angle."
 
-
+  arguments:
+  - position: 1
+    name: "angle"
+    type: Angle
   returns:
     - type: Vector
       description: "The right vector of the angle."

docs/classes/Angle/RotateAroundAxis.md

@@ -14,10 +14,15 @@ lua:
   description: "Rotates the angle around the specified axis by the specified degrees."
 
   arguments:
-    - name: "axis"
-      type: Vector
-    - name: "degrees"
-      type: number
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "axis"
+    type: Vector
+  - position: 3
+    name: "degrees"
+    type: number
   returns:
     - type: Angle
       description: "The rotated angle."

docs/classes/Angle/Scale.md

@@ -14,8 +14,12 @@ lua:
   description: "Modifies the existing angle, scaling it by a number."
 
   arguments:
-    - name: "scaleBy"
-      type: number
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "scaleBy"
+    type: number
   returns:
     - type: Angle
       description: "The same angle, now scaled."

docs/classes/Angle/Up.md

@@ -13,7 +13,10 @@ lua:
   realm: shared
   description: "Returns the up vector of the angle."
 
-
+  arguments:
+  - position: 1
+    name: "angle"
+    type: Angle
   returns:
     - type: Vector
       description: "The up vector of the angle."

docs/classes/Angle/__add.md

@@ -14,8 +14,12 @@ lua:
   description: "Metatable that is called when the angle is to be added to another angle."
 
   arguments:
-    - name: "angle2"
-      type: Angle
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "angle2"
+    type: Angle
   returns:
     - type: Angle
       description: "The added angle."

docs/classes/Angle/__div.md

@@ -14,8 +14,12 @@ lua:
   description: "Metatable that is called when the angle is to be divided by a number."
 
   arguments:
-    - name: "number"
-      type: number
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "number"
+    type: number
   returns:
     - type: Angle
       description: "The divided angle."

docs/classes/Angle/__eq.md

@@ -14,8 +14,12 @@ lua:
   description: "Metatable that is called when the angle is to be compared with another angle."
 
   arguments:
-    - name: "angle2"
-      type: Angle
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "other"
+    type: Angle
   returns:
     - type: boolean
       description: "True if the angles are equal, false otherwise."

docs/classes/Angle/__index.md

@@ -14,8 +14,12 @@ lua:
   description: "Metatable that is called when a key is not found in the table."
 
   arguments:
-    - name: "field"
-      type: string
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "field"
+    type: string
   returns:
     - type: any
       description: "The value of the key."

docs/classes/Angle/__mul.md

@@ -14,8 +14,12 @@ lua:
   description: "Metatable that is called when the angle is to be multiplied by a number."
 
   arguments:
-    - name: "number"
-      type: number
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "number"
+    type: number
   returns:
     - type: Angle
       description: "The multiplied angle."

docs/classes/Angle/__newindex.md

@@ -14,8 +14,12 @@ lua:
   description: "Metatable that is called to set a value to a key that is not found in the table."
 
   arguments:
-    - name: "field"
-      type: string
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "field"
+    type: string
   returns:
 
 ---

docs/classes/Angle/__sub.md

@@ -14,8 +14,12 @@ lua:
   description: "Metatable that is called when the angle is to be subtracted from another angle."
 
   arguments:
-    - name: "angle2"
-      type: Angle
+  - position: 1
+    name: "angle"
+    type: Angle
+  - position: 2
+    name: "angle2"
+    type: Angle
   returns:
     - type: Angle
       description: "The subtracted angle."

docs/classes/Angle/__tostring.md

@@ -13,7 +13,10 @@ lua:
   realm: shared
   description: "Metatable that is called when the angle is to be converted to a string."
 
-
+  arguments:
+  - position: 1
+    name: "angle"
+    type: Angle
   returns:
     - type: string
       description: "The string representation of the angle."

docs/classes/Angle/__unm.md

@@ -13,7 +13,10 @@ lua:
   realm: shared
   description: "Metatable that is called when the angle is to be negated."
 
-
+  arguments:
+  - position: 1
+    name: "angle"
+    type: Angle
   returns:
     - type: Angle
       description: "The negated angle."

docs/classes/AudioChannel/Get3dCone.md

@@ -0,0 +1,31 @@
+---
+template: lua-class-function.html
+title: Get3dCone
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: AudioChannel
+  function: Get3dCone
+  realm: shared
+  description: "Gets the 3D cone of the audio channel"
+
+  arguments:
+  - position: 1
+    name: "audioChannel"
+    type: AudioChannel
+  returns:
+    - type: number
+      description: "The inner angle of the 3D cone"
+    - type: number
+      description: "The outer angle of the 3D cone"
+    - type: number
+      description: "The outer volume of the 3D cone"
+---
+
+<div class="lua__search__keywords">
+AudioChannel:Get3dCone &#x2013; Gets the 3D cone of the audio channel
+</div>