summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-24 11:31:52 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-24 11:32:04 +0100
commit8b55b59b277c38140ed219276d5039d5c0162c81 (patch)
tree0a2cb40029a656412171ca3dad8c61cfd3b1b876
parentinterfacedoc: Strip leading "_" from parameters (diff)
downloadrtems-central-8b55b59b277c38140ed219276d5039d5c0162c81.tar.bz2
Revert "interfacedoc: Strip leading "_" from parameters"
This reverts commit d459b58772183bb987f350c4b463ff05c012520e.
-rw-r--r--rtemsspec/interfacedoc.py9
1 files changed, 3 insertions, 6 deletions
diff --git a/rtemsspec/interfacedoc.py b/rtemsspec/interfacedoc.py
index b6e17ef2..6109a711 100644
--- a/rtemsspec/interfacedoc.py
+++ b/rtemsspec/interfacedoc.py
@@ -105,10 +105,6 @@ 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"])
@@ -121,7 +117,7 @@ def _add_macro_definition(content: CContent, _mapper: ItemMapper, item: Item,
_value: Dict[str, Any]) -> None:
ret = "#define"
name = item["name"]
- params = [_sanitize_name(param["name"]) for param in item["params"]]
+ params = [param["name"] for param in item["params"]]
content.call_function(ret, name, params, semicolon="")
@@ -171,8 +167,9 @@ 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"``{_sanitize_name(param['name'])}``",
+ f"``{param_name}``",
mapper.substitute(f"This parameter {param['description']}"),
wrap=True)
if item["description"]: