blob: f1caa961f56dc9f5af961ff33ab534cc753b680a (
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
58
59
60
61
62
|
{#
# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#}
{% set v = item['value'] %}
{% if 'short_help' in v %}
{% set str = v['short_help'] %}
{% set str = this.unescape(str) %}
{# Summary/usage #}
{{ item['value']['path'] }}
-------------------------------------------------------------------------
.. code-block:: console
{{ this.reindent(str, 4) }}
{% endif %}
{% if 'long_help' in v %}
{% set long_help = v['long_help'] %}
{% set long_help = this.unescape(long_help) %}
{# This is seldom used and will likely be deprecated #}
{# Long help #}
.. code-block:: console
{{ this.reindent(long_help, 4) }}
{% endif %}
{% if 'siphon_block' in item['meta'] %}
{% set sb = item["meta"]["siphon_block"] %}
{% set sb = this.process_special(sb) %}
{% if sb %}
{# Extracted from the code in /*? ... ?*/ blocks #}
{# Description #}
{{ sb }}
{% endif %}
{% endif %}
{% if 'name' in meta or 'function' in v %}
{# Gives some developer-useful linking #}
{% if "name" in meta %}
Declaration: ``{{ meta['name'] }}`` `{{ meta["file"] }} line {{ item["meta"]["line_start"] }} <{{ this.repository_link }}{{ meta["file"] }}#L{{ item["meta"]["line_start"] }}>`_
{% endif %}
{% if "function" in v %}
Implementation: ``{{ v["function"] }}``
{% endif %}
{% endif %}
|
