Fix functions syntax

Author: Fernando-A-Rocha

functions/Element/getElementHealth.yaml

@@ -7,6 +7,10 @@ shared: &shared
   pair: 'setElementHealth'
   description: |
     This function returns the current health for the specified element. This can be a [[player]], [[ped]], [[vehicle]], or [[object]]. 
+  parameters:
+    - name: 'theElement'
+      type: 'element'
+      description: "The [[player]] or [[vehicle]] whose health you want to check."
   returns:
     description: |
       Returns a *float* indicating the element's health, *false* otherwise.

functions/Element/getElementPosition.yaml

@@ -16,6 +16,10 @@ shared: &shared
     - [[collision shape|Collision shapes]]
     - [[blip|Blips]]
     - [[radar area|Radar areas]]
+  parameters:
+    - name: 'theElement'
+      type: 'element'
+      description: "The element which you'd like to retrieve the location of"
   returns:
     description: |
       Returns three floats indicating the position of the element, x, y and z respectively.

functions/Element/setElementHealth.yaml

@@ -18,7 +18,7 @@ shared: &shared
   parameters:
     - name: 'theElement'
       type: 'element'
-      description: 'The player, ped, vehicle or object element whose health you want to set.'
+      description: 'The [[player]], [[ped]], [[vehicle]] or [[object]] element whose health you want to set.'
     - name: 'newHealth'
       type: 'float'
       description: 'A float indicating the new health to set for the element.'

functions/Element/setElementPosition.yaml

@@ -13,6 +13,23 @@ shared: &shared
     - |
       If you want to put a vehicle or player out of the water or simulate the position-resetting behaviour if CJ goes below the ground too far, then you need to retrieve a recommended coordinate on ground to place the element at. Take a look at this MTA forums post for steps in the right direction.
       https://forum.mtasa.com/topic/132891-important-helprespawn-vehicle/?do=findComment&comment=1003198
+  parameters:
+    - name: 'theElement'
+      type: 'element'
+      description: 'A valid [[element]] to be moved.'
+    - name: 'x'
+      type: 'float'
+      description: 'The x coordinate of the destination.'
+    - name: 'y'
+      type: 'float'
+      description: 'The y coordinate of the destination.'
+    - name: 'y'
+      type: 'float'
+      description: 'The z coordinate of the destination.'
+    - name: 'warp'
+      type: 'bool'
+      default: 'false'
+      description: 'teleports players, resetting any animations they were doing. Setting this to false preserves the current animation.'
   returns:
     description: |
       Returns *true* if the function was successful, *false* otherwise.

schemas/function.yaml

@@ -163,10 +163,6 @@ $defs:
           description: |
             The default value for this parameter, if none was given in the call to the function.
             This property automatically implicitly marks this parameter as optional.
-        optional:
-          type: boolean
-          default: false
-          description: If set to true, this parameter will be marked as optional.
 
   returns:
     type: object

web/resources/function.html

@@ -17,18 +17,26 @@ <h1 style="border-bottom: 3px solid #FF7F00;">{{ function.name }}</h1>
 <h2>Syntax</h2>
 {% for type_name in ['shared', 'client', 'server'] %}
 {% if function[type_name] %}
+    {% if function[type_name].returns %}
+        {% set return_type = function[type_name].returns["values"][0].type %}
+    {% else %}
+        {% set return_type = 'void' %}
+    {% endif %}
     {% if function[type_name].parameters %}
-        <pre><code class="language-lua">{{ function[type_name].name }}( {% for item in function[type_name].parameters %}{{ item.type }} {{ item.name }}{% if not loop.last %}, {% endif %}{% endfor %} )</code></pre>
+        <pre><code class="language-lua">{{ return_type }} {{ function[type_name].name }} ( {% for item in function[type_name].parameters %}{{ item.type }} {{ item.name }}{% if not loop.last %}, {% endif %}{% endfor %} )</code></pre>
         <ul>
         {% for item in function[type_name].parameters %}
             <li>{{ item.type }} <strong>{{ item.name }}</strong> : {{ item.description_html }}</li>
         {% endfor %}
         </ul>
+    {% else %}
+        <pre><code class="language-lua">{{ return_type }} {{ function[type_name].name }} ( )</code></pre>
     {% endif %}
 
 {% endif %}
 {% endfor %}
 
+<!-- Returns -->
 {% for type_name in ['shared', 'client', 'server'] %}
 {% if function[type_name] %}
     {% if function[type_name].returns %}

web/scripts/utils.py

@@ -20,9 +20,9 @@ def to_html(markdown_text, single_paragraph=False):
         html = re.sub(r'<p>(.*?)</p>', r'\1', html)
 
     # Custom link syntax
-    # Replace all [[string|text]] with <a href="/string">text</a>
-    html = re.sub(r'\[\[(.*?)\|(.*?)\]\]', r'<a href="/\1">\2</a>', html)
-    # Replace all [[string]] with <a href="/string">string</a>
-    html = re.sub(r'\[\[(.*?)\]\]', r'<a href="/\1">\1</a>', html)
+    # Replace all [[string|text]] with <a href="/string_with_underscores">text</a>
+    html = re.sub(r'\[\[(.*?)\|(.*?)\]\]', lambda m: f'<a href="/{m.group(1).replace(" ", "_")}">{m.group(2)}</a>', html)
+    # Replace all [[string]] with <a href="/string_with_underscores">string</a>
+    html = re.sub(r'\[\[(.*?)\]\]', lambda m: f'<a href="/{m.group(1).replace(" ", "_")}">{m.group(1)}</a>', html)
 
     return html