better doc generation support for that one hook we define in a macro

docs/classes/Angle/Init.md → docs/classes/Angle/Initialize.md

@@ -1,6 +1,6 @@
 ---
 template: lua-class-function.html
-title: Init
+title: Initialize
 icon: lua-shared
 tags:
   - lua
@@ -9,7 +9,7 @@ tags:
   - needs-example
 lua:
   library: Angle
-  function: Init
+  function: Initialize
   realm: shared
   description: "Initializes the angle with the specified values."
 
@@ -26,5 +26,5 @@ lua:
 ---
 
 <div class="lua__search__keywords">
-Angle:Init &#x2013; Initializes the angle with the specified values.
+Angle:Initialize &#x2013; Initializes the angle with the specified values.
 </div>

docs/classes/Angle/Invalidate.md

@@ -11,7 +11,7 @@ lua:
   library: Angle
   function: Invalidate
   realm: shared
-  description: "Invalidates the angle."
+  description: "Makes the angle invalid."
 
 
   returns:
@@ -20,5 +20,5 @@ lua:
 ---
 
 <div class="lua__search__keywords">
-Angle:Invalidate &#x2013; Invalidates the angle.
+Angle:Invalidate &#x2013; Makes the angle invalid.
 </div>

docs/classes/Angle/Normalize.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: Normalize
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: Angle
+  function: Normalize
+  realm: shared
+  description: "Modifies the existing angle, normalizing it between -180 to 180 degrees pitch, yaw and roll."
+
+
+  returns:
+    - type: Angle
+      description: "The same angle, now normalized."
+---
+
+<div class="lua__search__keywords">
+Angle:Normalize &#x2013; Modifies the existing angle, normalizing it between -180 to 180 degrees pitch, yaw and roll.
+</div>

docs/classes/Angle/Scale.md

@@ -18,7 +18,7 @@ lua:
       type: number
   returns:
     - type: Angle
-      description: "The scaled angle."
+      description: "The same angle, now scaled."
 ---
 
 <div class="lua__search__keywords">

docs/classes/Angle/__mul.md

@@ -13,7 +13,9 @@ lua:
   realm: shared
   description: "Metatable that is called when the angle is to be multiplied by a number."
 
-
+  arguments:
+    - name: "number"
+      type: number
   returns:
     - type: Angle
       description: "The multiplied angle."

docs/classes/EffectData/GetAngles.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: GetAngles
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: EffectData
+  function: GetAngles
+  realm: shared
+  description: "Get the angles of the effect."
+
+
+  returns:
+    - type: Angle
+      description: "Angles"
+---
+
+<div class="lua__search__keywords">
+EffectData:GetAngles &#x2013; Get the angles of the effect.
+</div>

docs/classes/EffectData/GetAttachmentIndex.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: GetAttachmentIndex
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: EffectData
+  function: GetAttachmentIndex
+  realm: shared
+  description: "Get the attachment ID for the effect."
+
+
+  returns:
+    - type: integer
+      description: "Attachment ID"
+---
+
+<div class="lua__search__keywords">
+EffectData:GetAttachmentIndex &#x2013; Get the attachment ID for the effect.
+</div>

docs/classes/EffectData/GetColor.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: GetColor
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: EffectData
+  function: GetColor
+  realm: shared
+  description: "Get the byte described as the color of the effect."
+
+
+  returns:
+    - type: integer
+      description: "Color"
+---
+
+<div class="lua__search__keywords">
+EffectData:GetColor &#x2013; Get the byte described as the color of the effect.
+</div>

docs/classes/EffectData/GetDamageType.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: GetDamageType
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: EffectData
+  function: GetDamageType
+  realm: shared
+  description: "Get the damage type of the effect."
+
+
+  returns:
+    - type: integer
+      description: "Damage type"
+---
+
+<div class="lua__search__keywords">
+EffectData:GetDamageType &#x2013; Get the damage type of the effect.
+</div>

docs/classes/EffectData/GetEntity.md

@@ -1,24 +1,24 @@
 ---
 template: lua-class-function.html
 title: GetEntity
-icon: lua-client
+icon: lua-shared
 tags:
   - lua
-  - client
+  - shared
   - needs-verification
   - needs-example
 lua:
   library: EffectData
   function: GetEntity
-  realm: client
-  description: "Get the entity."
+  realm: shared
+  description: "Get the entity the effect is assigned to."
 
 
   returns:
     - type: Entity
-      description: "Entity."
+      description: "The entity the effect is assigned to."
 ---
 
 <div class="lua__search__keywords">
-EffectData:GetEntity &#x2013; Get the entity.
+EffectData:GetEntity &#x2013; Get the entity the effect is assigned to.
 </div>

docs/classes/EffectData/GetEntityIndex.md

@@ -1,17 +1,17 @@
 ---
 template: lua-class-function.html
 title: GetEntityIndex
-icon: lua-client
+icon: lua-server
 tags:
   - lua
-  - client
+  - server
   - needs-verification
   - needs-example
 lua:
   library: EffectData
   function: GetEntityIndex
-  realm: client
-  description: "Get the entity index."
+  realm: server
+  description: "Get the entity index of the entity the effect is assigned to."
 
 
   returns:
@@ -20,5 +20,5 @@ lua:
 ---
 
 <div class="lua__search__keywords">
-EffectData:GetEntityIndex &#x2013; Get the entity index.
+EffectData:GetEntityIndex &#x2013; Get the entity index of the entity the effect is assigned to.
 </div>

docs/classes/EffectData/GetFlags.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: GetFlags
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: EffectData
+  function: GetFlags
+  realm: shared
+  description: "Get the flags of the effect."
+
+
+  returns:
+    - type: integer
+      description: "The flags of the effect."
+---
+
+<div class="lua__search__keywords">
+EffectData:GetFlags &#x2013; Get the flags of the effect.
+</div>

docs/classes/EffectData/GetHitBox.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: GetHitBox
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: EffectData
+  function: GetHitBox
+  realm: shared
+  description: "Get the hit box ID of the effect."
+
+
+  returns:
+    - type: integer
+      description: "Hit box ID"
+---
+
+<div class="lua__search__keywords">
+EffectData:GetHitBox &#x2013; Get the hit box ID of the effect.
+</div>

docs/classes/EffectData/GetMagnitude.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: GetMagnitude
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: EffectData
+  function: GetMagnitude
+  realm: shared
+  description: "Get the magnitude of the effect."
+
+
+  returns:
+    - type: number
+      description: "Magnitude"
+---
+
+<div class="lua__search__keywords">
+EffectData:GetMagnitude &#x2013; Get the magnitude of the effect.
+</div>

docs/classes/EffectData/GetMaterialIndex.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: GetMaterialIndex
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: EffectData
+  function: GetMaterialIndex
+  realm: shared
+  description: "Get the material index of the effect."
+
+
+  returns:
+    - type: integer
+      description: "Material index"
+---
+
+<div class="lua__search__keywords">
+EffectData:GetMaterialIndex &#x2013; Get the material index of the effect.
+</div>

docs/classes/EffectData/GetNormal.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: GetNormal
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: EffectData
+  function: GetNormal
+  realm: shared
+  description: "Get the normalized direction vector of the effect."
+
+
+  returns:
+    - type: Vector
+      description: "Normal"
+---
+
+<div class="lua__search__keywords">
+EffectData:GetNormal &#x2013; Get the normalized direction vector of the effect.
+</div>

docs/classes/EffectData/GetOrigin.md

@@ -0,0 +1,24 @@
+---
+template: lua-class-function.html
+title: GetOrigin
+icon: lua-shared
+tags:
+  - lua
+  - shared
+  - needs-verification
+  - needs-example
+lua:
+  library: EffectData
+  function: GetOrigin
+  realm: shared
+  description: "Get the origin position of the effect."
+
+
+  returns:
+    - type: Vector
+      description: "Origin"
+---
+
+<div class="lua__search__keywords">
+EffectData:GetOrigin &#x2013; Get the origin position of the effect.
+</div>