Back to Hammerspoon

Hammerspoon docs: {{ module.name }}

scripts/docs/templates/module.j2.html

1.4.271.3 KB
Original Source

{% if module["submodules"]|length > 0 %}

Submodules

{% for submodule in module["submodules"] %} - {{ module.name }}.{{ submodule }} {% endfor %} {% endif %}

API Overview

{% for type in type_order %} {# Considering: {{ type }} ({{ module[type]|length }}) #} {% if module[type]|length > 0 %} - {{ type }}s - {{ type_desc[type] }}

{% for item in module[type] %} - {{ item.name }} {% endfor %} {% endif %} {% endfor %}

API Documentation

{% for type in type_order %} {% if module[type]|length > 0 %}

{{ type}}s

{% for item in module[type] %}

{{ item.name }}

| Signature | {{ item.def_gfm }} | | Type | {{ item.type }} | | Description | {{ item.desc_gfm }} | {% if item.type == "Function" or item.type == "Method" or item.type == "Constructor" %} | Parameters | {{ item.parameters_gfm }} | | Returns | {{ item.returns_gfm }} | {% endif %} {% if item.notes|length > 0 %} | Notes | {{ item.notes_gfm }} | {% endif %} {% if item.examples|length > 0 %} | Examples | {{ item.examples_gfm }} | {% endif %} | Source | {{ item.file }} line {{ item.lineno }} |

{% endfor %} {% endif %} {% endfor %}