wgsldoc 0.2.1

Documentation generator for WGSL shaders
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

{% extends "base.html.tera" %}
{% block content %}
   <h1>Module <code>{{ module.name }}</code></h1>
   <hr>
   {{ module.summary }}
   {% if imports %}
      <h2>Imports</h2>
      <hr>
      {% for imp in imports %}
         <li>
            <i>{{ imp.path }}</i> as <code>
               {% if imp.registered %}
                  <a href="{{ assets_subpath }}/modules/{{ imp.module_name }}/index.html">{{ imp.name }}</a>
               {% else %}
                  {{ imp.name }}
               {% endif %}
            </code>
            {% if imp.docs %}
               <br>
               {{ imp.docs }}
            {% endif %}
         </li>
      {% endfor %}
   {% endif %}
   {% if functions %}
      <h2>Functions</h2>
      <hr>
      {% for function in functions %}
         {% if function.summary %}
            <li><code><a href="{{ assets_subpath }}/modules/{{ module.name }}/fn.{{ function.name }}.html">{{ function.name }}</a></code> - {{ function.summary }}</li>
         {% else %}
            <li><code><a href="{{ assets_subpath }}/modules/{{ module.name }}/fn.{{ function.name }}.html">{{ function.name }}</a></code></li>
         {% endif %}
      {% endfor %}
   {% endif %}
   {% if structures %}
      <h2>Structures</h2>
      <hr>
      {% for structure in structures %}
         {% if structure.summary %}
            <li><code><a href="{{ assets_subpath }}/modules/{{ module.name }}/struct.{{ structure.name }}.html">{{ structure.name }}</a></code> - {{ structure.summary }}</li>
         {% else %}
            <li><code><a href="{{ assets_subpath }}/modules/{{ module.name }}/struct.{{ structure.name }}.html">{{ structure.name }}</a></code></li>
         {% endif %}
      {% endfor %}
   {% endif %}
{% endblock content %}