summaryrefslogtreecommitdiffstats
path: root/rtemsspec/interface.py
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-01-22 14:15:57 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-02-01 06:59:01 +0100
commit331cecb5a708f15daf982c7f399600ac2f602bf7 (patch)
treef04ca21bea375794b74261e00c772f388652fe0a /rtemsspec/interface.py
parentinterfacedoc: Add directive constraints (diff)
downloadrtems-central-331cecb5a708f15daf982c7f399600ac2f602bf7.tar.bz2
interface: Use paragraph for notes
Reorder sections to be in line with the Sphinx documentation.
Diffstat (limited to 'rtemsspec/interface.py')
-rw-r--r--rtemsspec/interface.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/rtemsspec/interface.py b/rtemsspec/interface.py
index 7adf63aa..84623dc2 100644
--- a/rtemsspec/interface.py
+++ b/rtemsspec/interface.py
@@ -410,11 +410,10 @@ class Node:
with content.doxygen_block():
content.add_ingroup(_get_group_identifiers(ingroups))
content.add_brief_description(self.substitute_text(item["brief"]))
- content.doxyfy(self.substitute_text(item["description"]))
- content.doxyfy(self.substitute_text(item["notes"]))
if "params" in item:
content.add_param_description(item["params"],
self.substitute_text)
+ content.doxyfy(self.substitute_text(item["description"]))
if "return" in item:
ret = item["return"]
for retval in ret["return-values"]:
@@ -423,6 +422,7 @@ class Node:
f"@retval {retval['value']} "))
content.wrap(self.substitute_text(ret["return"]),
initial_indent="@return ")
+ content.add_paragraph("Notes", self.substitute_text(item["notes"]))
return content
def _add_generic_definition(self, get_lines: GetLines) -> None: