[rtems-central commit] Revert "interfacedoc: Strip leading "_" from parameters"

Sebastian Huber sebh at rtems.org
Tue Nov 24 10:32:17 UTC 2020


Module:    rtems-central
Branch:    master
Commit:    8b55b59b277c38140ed219276d5039d5c0162c81
Changeset: http://git.rtems.org/rtems-central/commit/?id=8b55b59b277c38140ed219276d5039d5c0162c81

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Nov 24 11:31:52 2020 +0100

Revert "interfacedoc: Strip leading "_" from parameters"

This reverts commit d459b58772183bb987f350c4b463ff05c012520e.

---

 rtemsspec/interfacedoc.py | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

diff --git a/rtemsspec/interfacedoc.py b/rtemsspec/interfacedoc.py
index b6e17ef..6109a71 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"]:



More information about the vc mailing list