mirror/fmt
1
0
Fork 0
mirror of https://github.com/fmtlib/fmt.git synced 2024-09-15 15:13:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve apidoc rendering

Browse Source
This commit is contained in:
Victor Zverovich 2024-06-01 10:24:46 -07:00
parent 34b85678f9
commit e3910b8a9c
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
support/mkdocstrings_handlers/cxx/__init__.py
View File

@ -12,6 +12,7 @@ class Definition:
def __init__(self, name: str): def __init__(self, name: str):
self.name = name self.name = name
self.params = None self.params = None
self.members = None
# A map from Doxygen to HTML tags. # A map from Doxygen to HTML tags.
tag_map = { tag_map = {
@ -91,10 +92,10 @@ def render_decl(d: Definition) -> None:
text += '>\n' text += '>\n'
text += d.type + ' ' + d.name text += d.type + ' ' + d.name
if d.params is not None: if d.params is not None:
params = ', '.join( params = ', '.join([f'{p.type} {p.name}' for p in d.params])
[f'{escape_html(p.type)} {p.name}' for p in d.params]) text += '(' + escape_html(params) + ')'
text += '(' + params + ')'
if d.trailing_return_type: if d.trailing_return_type:
text += '\n ' if len(d.name) + len(params) > 60 else ''
text += ' -> ' + escape_html(d.trailing_return_type) text += ' -> ' + escape_html(d.trailing_return_type)
text += ';' text += ';'
text += '</code></pre>\n' text += '</code></pre>\n'
@ -194,7 +195,7 @@ class CxxHandler(BaseHandler):
d.template_params = get_template_params(node) d.template_params = get_template_params(node)
d.desc = get_description(node) d.desc = get_description(node)
d.members = [] d.members = []
for m in node.findall('sectiondef/memberdef'): for m in node.findall('sectiondef[@kind="public-attrib"]/memberdef'):
name = m.find('name').text name = m.find('name').text
member = Definition(name if name else '') member = Definition(name if name else '')
type = m.find('type').text type = m.find('type').text
@ -209,10 +210,9 @@ class CxxHandler(BaseHandler):
text += render_decl(d) text += render_decl(d)
text += '<div class="docblock-desc">\n' text += '<div class="docblock-desc">\n'
text += doxyxml2html(d.desc) text += doxyxml2html(d.desc)
if d.params is None: if d.members is not None:
for m in d.members: for m in d.members:
text += render_decl(m) text += self.render(m, config)
text += doxyxml2html(m.desc)
text += '</div>\n' text += '</div>\n'
text += '</div>\n' text += '</div>\n'
return text return text