summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-24 10:51:25 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-24 10:56:06 +0100
commitd459b58772183bb987f350c4b463ff05c012520e (patch)
tree7141c8b1610b2d287b0c8afee2d8e1840b6a899b
parentinterfacedoc: Support macros (diff)
downloadrtems-central-d459b58772183bb987f350c4b463ff05c012520e.tar.bz2
interfacedoc: Strip leading "_" from parameters
-rw-r--r--rtemsspec/interfacedoc.py9
1 files changed, 6 insertions, 3 deletions
diff --git a/rtemsspec/interfacedoc.py b/rtemsspec/interfacedoc.py
index 6109a711..b6e17ef2 100644
--- a/rtemsspec/interfacedoc.py
+++ b/rtemsspec/interfacedoc.py
@@ -105,6 +105,10 @@ def _generate_introduction(target: str, group: Item,
content.write(target)
+def _sanitize_name(name: str) -> str:
+ return name.lstrip("_")
+
+
def _add_function_definition(content: CContent, mapper: ItemMapper, item: Item,
value: Dict[str, Any]) -> None:
ret = mapper.substitute(value["return"])
@@ -117,7 +121,7 @@ def _add_macro_definition(content: CContent, _mapper: ItemMapper, item: Item,
_value: Dict[str, Any]) -> None:
ret = "#define"
name = item["name"]
- params = [param["name"] for param in item["params"]]
+ params = [_sanitize_name(param["name"]) for param in item["params"]]
content.call_function(ret, name, params, semicolon="")
@@ -167,9 +171,8 @@ def _generate_directive(content: SphinxContent, mapper: _Mapper,
if item["params"]:
content.add(".. rubric:: PARAMETERS:")
for param in item["params"]:
- param_name = mapper.substitute(param["name"])
content.add_definition_item(
- f"``{param_name}``",
+ f"``{_sanitize_name(param['name'])}``",
mapper.substitute(f"This parameter {param['description']}"),
wrap=True)
if item["description"]: