IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

C, move info-fields from all objects to just function and macro

Browse Source
This commit is contained in:
Jakob Lykke Andersen 2021-10-01 17:45:10 +02:00
parent 063dcfd9ec
commit dd53cd2f8c
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
sphinx/domains/c.py
View File

@ -3130,18 +3130,6 @@ class CObject(ObjectDescription[ASTDeclaration]):
Description of a C language object. 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 = { option_spec: OptionSpec = {
'noindexentry': directives.flag, 'noindexentry': directives.flag,
} }
@ -3344,13 +3332,30 @@ class CMemberObject(CObject):
return self.objtype 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): class CFunctionObject(CObject):
object_type = 'function' object_type = 'function'
doc_field_types = _function_doc_field_types.copy()
class CMacroObject(CObject): class CMacroObject(CObject):
object_type = 'macro' object_type = 'macro'
doc_field_types = _function_doc_field_types.copy()
class CStructObject(CObject): class CStructObject(CObject):
object_type = 'struct' object_type = 'struct'