aboutsummaryrefslogtreecommitdiffstats
path: root/docs/service.template
blob: 639990ed984d9041273d4d52972ae88a5ae3b124 (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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<h1><tt>{{name}}</tt></h1>

{{#workInProgress}}
<fieldset class="workInProgress">
  <legend>Work In Progress</legend>
  This page is currently being revised. It might be incomplete or contain inaccuracies.
  {{{workInProgress.description}}}
</fieldset>
{{/workInProgress}}

{{#deprecated}}
<fieldset class="deprecated">
  <legend>Deprecated API</legend>
  {{deprecated}}
</fieldset>
{{/deprecated}}

<h2>Description</h2>
{{{description}}}

<h2>Dependencies</h2>
<ul>
  {{#requires}}
  <li><tt>{{name}}</tt></li>
  {{/requires}}
</ul>

{{#method.length}}
<h2>Methods</h2>
<ul>
  {{#method}}
  <li><tt>{{shortName}}()</tt>: {{{description}}}</li>
  {{/method}}
</ul>
{{/method.length}}

{{#property.length}}
<h2>Properties</h2>
<ul>
  {{#property}}
  <li><tt>{{name}}:{{#type}}{{type}}{{/type}}</tt>{{#description}}: {{{description}}}{{/description}}</li>
  {{/property}}
</ul>
{{/property.length}}

{{#example}}
<h2>Example</h2>
{{{exampleDescription}}}
<doc:example>
  <doc:source>
{{/example}}
    {{{example}}}
{{#example}}
  </doc:source>
  {{#scenario}}<doc:scenario>{{{scenario}}}</doc:scenario>{{/scenario}}
</doc:example>
{{/example}}