aboutsummaryrefslogtreecommitdiff
path: root/func.etlua
blob: f6396030fd124b7ed3e1c617b8d0a566c041d591 (plain)
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
<section>
	<h4 id="<%- name %>">
		<%- name %>(
		<% for n, param in pairs(data.params) do %>
			<% if param.optional then %>[<% end %>
			<% if n ~= 1 then %>,<% end %>
			<%- param.type %> <%- param.name %>
			<% if param.optional then %>]<% end %>
		<% end %>
		)
	</h4>
	<p><%- data.short_desc %>
	<p><%- data.desc %>
	<% if #data.params > 0 then %>
		<h5>Parameters</h5>
		<ul>
		<% for _, param in pairs(data.params) do %>
			<li>
				<p><b><%- param.name %></b>
				<% if param.optional then %>(optional)<% end %>
				<% if param.type then %>
					(<a href="<%- param.type %>.html"><%- param.type %></a>)
				<% end %>
				<p><%- param.description %>
			</li>
		<% end %>
		</ul>
	<% end %>
	<% if #data.returns > 0 then %>
		<h5>Returns</h5>
		<ul>
		<% for _, ret in pairs(data.returns) do %>
			<li>
				<p><a href="<%- ret.type %>.html"><%- ret.type %></a>
				<p><%- ret.description %>
			</li>
		<% end %>
		</ul>
	<% end %>
	<p> Defined at <%- data.file %>:<%- data.line %>
</section>