docs/_scripts/siphon_templates/markdown/syscfg/item_format.md

   1 {#
   2 # Copyright (c) 2016 Comcast Cable Communications Management, LLC.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 #}
  16 {% set v = item['value'] %}
  17 {{ "@section %s %s" % (meta['label'], item['name']) }}
  18 {% if 'siphon_block' in item['meta'] %}
  19 {% set sb = item["meta"]["siphon_block"] %}
  20 {% if sb %}
  21 {# Extracted from the code in /*? ... ?*/ blocks #}
  22
  23 ### Description
  24
  25 {{ sb }}
  26 {% endif %}
  27 {% endif %}
  28 {% if "name" in meta or "function" in item %}
  29 {# Gives some developer-useful linking #}
  30
  31 ### Declaration and implementation
  32 {% if "name" in meta %}
  33
  34 {{ "Declaration: @ref %s (@ref %s line %d)" %
  35    (meta['name'], meta["file"], item["meta"]["line_start"]) }}
  36 {% endif %}
  37 {% if "function" in item %}
  38
  39 {{ "Implementation: @ref %s." % item["function"] }}
  40 {% endif %}
  41 {% endif %}
  42