diff options
| author | Gerard Marull-Paretas <gerard.marull@nordicsemi.no> | 2021-10-01 10:20:01 +0200 |
|---|---|---|
| committer | Gerard Marull-Paretas <gerard.marull@nordicsemi.no> | 2021-10-01 10:33:32 +0200 |
| commit | 3387f3b1aa171d548895d0cae580d39ed6c0d0bb (patch) | |
| tree | c93ef45bf8d9b9591caee5238d041f7fa9a7187d | |
| parent | 0424210614772db35f566d08349fcd24f2b2a4b7 (diff) | |
| download | sphinx-git-3387f3b1aa171d548895d0cae580d39ed6c0d0bb.tar.gz | |
C, add support for return value list
Add support for a new doc field type that allows to display a list of
return values.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
| -rw-r--r-- | sphinx/domains/c.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index 58a0c7014..3950b5f64 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -36,7 +36,7 @@ from sphinx.util.cfamily import (ASTAttribute, ASTBaseBase, ASTBaseParenExprList float_literal_suffix_re, hex_literal_re, identifier_re, integer_literal_re, integers_literal_suffix_re, octal_literal_re, verify_description_mode) -from sphinx.util.docfields import Field, TypedField +from sphinx.util.docfields import Field, GroupedField, TypedField from sphinx.util.docutils import SphinxDirective from sphinx.util.nodes import make_refnode from sphinx.util.typing import OptionSpec @@ -3134,6 +3134,8 @@ class CObject(ObjectDescription[ASTDeclaration]): TypedField('parameter', label=_('Parameters'), names=('param', 'parameter', 'arg', 'argument'), typerolename='expr', typenames=('type',)), + GroupedField('retval', label=_('Return values'), + names=('retvals', 'retval')), Field('returnvalue', label=_('Returns'), has_arg=False, names=('returns', 'return')), Field('returntype', label=_('Return type'), has_arg=False, |