Skip to content

Commit

Permalink
renderer: use retval type for the retval fields
Browse files Browse the repository at this point in the history
This change makes @RetVal fields to render as a separate list,
independent of the @return/s entries.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
  • Loading branch information
gmarull committed Oct 1, 2021
1 parent 327374d commit f97fb82
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion breathe/renderer/sphinxrenderer.py
Expand Up @@ -2211,7 +2211,7 @@ def visit_docparamlist(self, node) -> List[Node]:
"param": "param",
"exception": "throws",
"templateparam": "tparam",
"retval": "returns",
"retval": "retval",
}

# https://docutils.sourceforge.io/docs/ref/doctree.html#field-list
Expand Down

0 comments on commit f97fb82

Please sign in to comment.