aboutsummaryrefslogtreecommitdiffstats
path: root/doxygen/siphon_templates/clicmd/item_format.md
diff options
context:
space:
mode:
authorChris Luke <chrisy@flirble.org>2016-10-05 15:45:19 -0400
committerChris Luke <chris_luke@comcast.com>2016-11-28 18:23:35 +0000
commitc3f92adf6be41263eb466e074e4136d29b50b59a (patch)
tree7eecad6aa039bb8a2f6ec5b068d6be9914a8815b /doxygen/siphon_templates/clicmd/item_format.md
parent39f9973f89fe6d44ee3be5d1dd4457d20530d4aa (diff)
Add support for using documentation siphons in multiple ways
Experiental support for generating multiple output formats from the same siphoned data. Adds a contrived example to generate a plain list of all CLI commands (the "itemlist" format). Eventually we can consider moving the tempate procesisng into the Output class as well as a way to override how the data is traversed (ordered). Change-Id: I77629a74a8fa0c7e583993469dc50491f72f13e7 Signed-off-by: Chris Luke <chrisy@flirble.org>
Diffstat (limited to 'doxygen/siphon_templates/clicmd/item_format.md')
-rw-r--r--doxygen/siphon_templates/clicmd/item_format.md59
1 files changed, 0 insertions, 59 deletions
diff --git a/doxygen/siphon_templates/clicmd/item_format.md b/doxygen/siphon_templates/clicmd/item_format.md
deleted file mode 100644
index 288dae40f24..00000000000
--- a/doxygen/siphon_templates/clicmd/item_format.md
+++ /dev/null
@@ -1,59 +0,0 @@
-{#
-# 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'] %}
-{{ "@section %s %s" % (meta['label'], v['path']) }}
-{% if 'short_help' in v %}
-
-### Summary/usage
-
-{% set str = v['short_help'] %}
-{% set period = "." if str[-1] != "." else "" %}
-{% set prefix = " " if "[" in str or "&lt;" in str or "|" in str else "" %}
-{% set str = this.unescape(str) %}
-{{ "%s%s%s" % (prefix, str, period) }}
-{% endif %}
-{% if 'long_help' in v %}
-{# This is seldom used and will likely be deprecated #}
-
-### Long help
-
-{{ v['long_help'] }}
-{% endif %}
-{% if 'siphon_block' in item['meta'] %}
-{% set sb = item["meta"]["siphon_block"] %}
-{% 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 #}
-
-### Declaration and implementation
-{% if "name" in meta %}
-
-{{ "Declaration: @ref %s (@ref %s line %d)" %
- (meta['name'], meta["file"], item["meta"]["line_start"]) }}
-{% endif %}
-{% if "function" in v %}
-
-{{ "Implementation: @ref %s." % v["function"] }}
-{% endif %}
-{% endif %}
-