diff options
| author | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-10-01 17:45:10 +0200 |
|---|---|---|
| committer | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-10-01 17:45:10 +0200 |
| commit | dd53cd2f8c78737aac1ae38a3d4ab8470fb875fe (patch) | |
| tree | 660f59d6eb6018ee8131e9d5f70e586c4a0f396f | |
| parent | 063dcfd9ec3f9fd46eeec98a40efb01c61a359a0 (diff) | |
| download | sphinx-git-dd53cd2f8c78737aac1ae38a3d4ab8470fb875fe.tar.gz | |
C, move info-fields from all objects to just function and macro
| -rw-r--r-- | sphinx/domains/c.py | 29 |
1 files changed, 17 insertions, 12 deletions
diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index 3950b5f64..9acbdd5f8 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -3130,18 +3130,6 @@ class CObject(ObjectDescription[ASTDeclaration]): Description of a C language object. """ - doc_field_types = [ - 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, - names=('rtype',)), - ] - option_spec: OptionSpec = { 'noindexentry': directives.flag, } @@ -3344,13 +3332,30 @@ class CMemberObject(CObject): return self.objtype +_function_doc_field_types = [ + 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, + names=('rtype',)), +] + + class CFunctionObject(CObject): object_type = 'function' + doc_field_types = _function_doc_field_types.copy() + class CMacroObject(CObject): object_type = 'macro' + doc_field_types = _function_doc_field_types.copy() + class CStructObject(CObject): object_type = 'struct' |