From cb4eca2bdd6fcaf243be009e0e6ef50b0deec5c0 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 2 Dec 2020 11:12:42 +0100 Subject: interfacedoc: Fix format of parameter names --- rtemsspec/interfacedoc.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/rtemsspec/interfacedoc.py b/rtemsspec/interfacedoc.py index 5e7e3106..caeb4cb3 100644 --- a/rtemsspec/interfacedoc.py +++ b/rtemsspec/interfacedoc.py @@ -40,6 +40,10 @@ ItemMap = Dict[str, Item] INTERFACE = "Interface" +def _sanitize_name(name: str) -> str: + return name.lstrip("_") + + def _forward_declaration(item: Item) -> str: target = item.parent("interface-target") return f"{target['interface-type']} {target['name']}" @@ -65,7 +69,7 @@ def _get_value_function(ctx: ItemGetValueContext) -> Any: def _get_param(ctx: ItemGetValueContext) -> Any: - return f"``{ctx.value[ctx.key].lstrip('_')}``" + return f"``{_sanitize_name(ctx.value[ctx.key])}``" class _Mapper(SphinxMapper): @@ -115,7 +119,9 @@ def _add_function_definition(content: CContent, mapper: ItemMapper, item: Item, value: Dict[str, Any]) -> None: ret = mapper.substitute(value["return"]) name = item["name"] - params = [mapper.substitute(param) for param in value["params"]] + params = [ + mapper.substitute(_sanitize_name(param)) for param in value["params"] + ] content.declare_function(ret, name, params) @@ -123,7 +129,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="") @@ -173,9 +179,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"]: -- cgit v1.2.3