summaryrefslogtreecommitdiff
path: root/rtemsspec/applconfig.py
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-08-06 10:24:16 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-08-06 14:10:08 +0200
commite9312e279dd296708a52c5cf7ae02305c03f4209 (patch)
tree4abee4089d1436f90ef56ec981a8faeb2b7a3cb3 /rtemsspec/applconfig.py
parenta89a5c6a09b10bcc5845bda00b20b3d78adb6930 (diff)
applconfig: Improve interface mappings
Diffstat (limited to '')
-rw-r--r--rtemsspec/applconfig.py29
1 files changed, 23 insertions, 6 deletions
diff --git a/rtemsspec/applconfig.py b/rtemsspec/applconfig.py
index bd08c8c7..fc6f48bd 100644
--- a/rtemsspec/applconfig.py
+++ b/rtemsspec/applconfig.py
@@ -350,12 +350,16 @@ def _get_value_sphinx_reference(ctx: ItemGetValueContext) -> Any:
return _SPHINX_DOC_REFS[ctx.key]
+def _get_value_sphinx_define(ctx: ItemGetValueContext) -> Any:
+ return f":c:macro:`{ctx.value[ctx.key]}`"
+
+
def _get_value_sphinx_function(ctx: ItemGetValueContext) -> Any:
- return f"``{ctx.value[ctx.key]}()``"
+ return f":c:func:`{ctx.value[ctx.key]}`"
-def _get_value_sphinx_code(ctx: ItemGetValueContext) -> Any:
- return f"``{ctx.value[ctx.key]}``"
+def _get_value_sphinx_type(ctx: ItemGetValueContext) -> Any:
+ return f":c:type:`{ctx.value[ctx.key]}`"
def _add_sphinx_get_values(mapper: ItemMapper) -> None:
@@ -365,12 +369,19 @@ def _add_sphinx_get_values(mapper: ItemMapper) -> None:
mapper.add_get_value(doc_ref, _get_value_none)
mapper.add_get_value(f"{doc_ref}/{key}",
_get_value_sphinx_reference)
+ mapper.add_get_value("interface/define:/name", _get_value_sphinx_define)
mapper.add_get_value("interface/function:/name",
_get_value_sphinx_function)
mapper.add_get_value("interface/macro:/name", _get_value_sphinx_function)
- mapper.add_get_value("interface/struct:/name", _get_value_sphinx_code)
- mapper.add_get_value("interface/typedef:/name", _get_value_sphinx_code)
- mapper.add_get_value("interface/union:/name", _get_value_sphinx_code)
+ mapper.add_get_value("interface/struct:/name", _get_value_sphinx_type)
+ mapper.add_get_value("interface/typedef:/name", _get_value_sphinx_type)
+ mapper.add_get_value("interface/union:/name", _get_value_sphinx_type)
+ mapper.add_get_value("interface/unspecified-define:/name",
+ _get_value_sphinx_define)
+ mapper.add_get_value("interface/unspecified-function:/name",
+ _get_value_sphinx_function)
+ mapper.add_get_value("interface/unspecified-type:/name",
+ _get_value_sphinx_type)
def _c_user_ref(ref: str, name: str) -> str:
@@ -446,12 +457,18 @@ def _add_doxygen_get_values(mapper: ItemMapper) -> None:
_get_value_doxygen_reference)
name = f"interface/appl-config-option/{opt}:/name"
mapper.add_get_value(name, get_value_hash)
+ mapper.add_get_value("interface/define:/name", get_value_hash)
mapper.add_get_value("interface/function:/name",
get_value_doxygen_function)
mapper.add_get_value("interface/macro:/name", get_value_doxygen_function)
mapper.add_get_value("interface/struct:/name", get_value_double_colon)
mapper.add_get_value("interface/typedef:/name", get_value_double_colon)
mapper.add_get_value("interface/union:/name", get_value_double_colon)
+ mapper.add_get_value("interface/unspecified-define:/name", get_value_hash)
+ mapper.add_get_value("interface/unspecified-function:/name",
+ get_value_doxygen_function)
+ mapper.add_get_value("interface/unspecified-type:/name",
+ get_value_double_colon)
def generate(config: dict, item_cache: ItemCache) -> None: