96 lines
3.3 KiB
HTML
96 lines
3.3 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>Hammerspoon docs: {{ module.name }}</title>
|
|
<style type="text/css">
|
|
a { text-decoration: none; }
|
|
a:hover { text-decoration: underline; }
|
|
th { background-color: #DDDDDD; vertical-align: top; padding: 3px; }
|
|
td { width: 100%; background-color: #EEEEEE; vertical-align: top; padding: 3px; }
|
|
table { width: 100% ; border: 1px solid #0; text-align: left; }
|
|
section > table table td { width: 0; }
|
|
</style>
|
|
<link rel="stylesheet" href="docs.css" type="text/css" media="screen" />
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<h1><a href="./index.html">docs</a> » {{ module.name }}</h1>
|
|
{{ module.doc_gfm }}
|
|
</header>
|
|
{% if module["submodules"]|length > 0 %}
|
|
<h3>Submodules</h3>
|
|
<ul>
|
|
{% for submodule in module["submodules"] %}
|
|
<li><a href="{{ module.name }}.{{ submodule }}.html">{{ module.name }}.{{ submodule }}</a></li>
|
|
{% endfor %}
|
|
</ul>
|
|
{% endif %}
|
|
<h3>API Overview</h3>
|
|
<ul>
|
|
{% for type in type_order %}
|
|
{# Considering: {{ type }} ({{ module[type]|length }}) #}
|
|
{% if module[type]|length > 0 %}
|
|
<li>{{ type }}s - {{ type_desc[type] }}</li>
|
|
<ul>
|
|
{% for item in module[type] %}
|
|
<li><a href="#{{ item.name }}">{{ item.name }}</a></li>
|
|
{% endfor %}
|
|
</ul>
|
|
{% endif %}
|
|
{% endfor %}
|
|
</ul>
|
|
<h3>API Documentation</h3>
|
|
{% for type in type_order %}
|
|
{% if module[type]|length > 0 %}
|
|
<h4 class="documentation-section">{{ type}}s</h4>
|
|
{% for item in module[type] %}
|
|
<section id="{{ item.name }}">
|
|
<a name="//apple_ref/cpp/{{ item.type }}/{{ item.name }}" class="dashAnchor"></a>
|
|
<h5><a href="#{{ item.name }}">{{ item.name }}</a></h5>
|
|
<table>
|
|
<tr>
|
|
<th>Signature</th>
|
|
<td><code>{{ item.def_gfm }}</code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>Type</th>
|
|
<td>{{ item.type }}</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Description</th>
|
|
<td>{{ item.desc }}</td>
|
|
</tr>
|
|
{% if item.type == "Function" or item.type == "Method" or item.type == "Constructor" %}
|
|
<tr>
|
|
<th>Parameters</th>
|
|
<td>{{ item.parameters_gfm }}</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>{{ item.returns_gfm }}</td>
|
|
</tr>
|
|
{% endif %}
|
|
{% if item.notes|length > 0 %}
|
|
<tr>
|
|
<th>Notes</th>
|
|
<td>{{ item.notes_gfm }}</td>
|
|
</tr>
|
|
{% endif %}
|
|
{% if item.examples|length > 0 %}
|
|
<tr>
|
|
<th>Examples</th>
|
|
<td>{{ item.examples_gfm }}</td>
|
|
</tr>
|
|
{% endif %}
|
|
<tr>
|
|
<th>Source</th>
|
|
<td><a href="{{ source_url_base }}{{ item.file }}#L{{ item.lineno }}">{{ item.file }} line {{ item.lineno }}</a></td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
{% endfor %}
|
|
{% endif %}
|
|
{% endfor %}
|
|
</body>
|
|
</html>
|