summaryrefslogtreecommitdiff
path: root/gr-utils/modtool/templates/gr-newmod/docs/doxygen/doxyxml/text.py
diff options
context:
space:
mode:
authorjapm48 <japm48@users.noreply.github.com>2020-03-26 16:01:00 +0100
committerMichael Dickens <michael.dickens@ettus.com>2020-04-10 14:57:01 -0400
commit4c4a85f2ebc43c9b7b3d5fdb8ad8387eae735f5f (patch)
tree10b5aa2671aafb9e393af7538177d2e48f60780d /gr-utils/modtool/templates/gr-newmod/docs/doxygen/doxyxml/text.py
parent78955a24c6c24f92f7b22ab9223e8e0b60b1dc4b (diff)
gr-utils: restructure {mod,block}tool folders
Move modtool and blocktool outside of the python folder, as per issue #2462.
Diffstat (limited to 'gr-utils/modtool/templates/gr-newmod/docs/doxygen/doxyxml/text.py')
-rw-r--r--gr-utils/modtool/templates/gr-newmod/docs/doxygen/doxyxml/text.py46
1 files changed, 46 insertions, 0 deletions
diff --git a/gr-utils/modtool/templates/gr-newmod/docs/doxygen/doxyxml/text.py b/gr-utils/modtool/templates/gr-newmod/docs/doxygen/doxyxml/text.py
new file mode 100644
index 0000000000..fa59668c01
--- /dev/null
+++ b/gr-utils/modtool/templates/gr-newmod/docs/doxygen/doxyxml/text.py
@@ -0,0 +1,46 @@
+#
+# Copyright 2010 Free Software Foundation, Inc.
+#
+# This file was generated by gr_modtool, a tool from the GNU Radio framework
+# This file is a part of gr-howto
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+#
+"""
+Utilities for extracting text from generated classes.
+"""
+from __future__ import unicode_literals
+
+def is_string(txt):
+ if isinstance(txt, str):
+ return True
+ try:
+ if isinstance(txt, str):
+ return True
+ except NameError:
+ pass
+ return False
+
+def description(obj):
+ if obj is None:
+ return None
+ return description_bit(obj).strip()
+
+def description_bit(obj):
+ if hasattr(obj, 'content'):
+ contents = [description_bit(item) for item in obj.content]
+ result = ''.join(contents)
+ elif hasattr(obj, 'content_'):
+ contents = [description_bit(item) for item in obj.content_]
+ result = ''.join(contents)
+ elif hasattr(obj, 'value'):
+ result = description_bit(obj.value)
+ elif is_string(obj):
+ return obj
+ else:
+ raise Exception('Expecting a string or something with content, content_ or value attribute')
+ # If this bit is a paragraph then add one some line breaks.
+ if hasattr(obj, 'name') and obj.name == 'para':
+ result += "\n\n"
+ return result