AuroraMiddleware/fmt
1
0
Fork 0
mirror of https://github.com/fmtlib/fmt.git synced 2024-12-01 22:20:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve apidoc generation

Browse Source
This commit is contained in:
Victor Zverovich 2024-06-01 07:02:45 -07:00
parent 1992746249
commit 4f330567e1
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -76,7 +76,8 @@ class CxxHandler(BaseHandler):
CASE_SENSE_NAMES = NO CASE_SENSE_NAMES = NO
INPUT = {0}/args.h {0}/base.h {0}/chrono.h {0}/color.h \ INPUT = {0}/args.h {0}/base.h {0}/chrono.h {0}/color.h \
{0}/core.h {0}/compile.h {0}/format.h {0}/os.h \ {0}/core.h {0}/compile.h {0}/format.h {0}/os.h \
{0}/ostream.h {0}/printf.h {0}/ranges.h {0}/xchar.h {0}/ostream.h {0}/printf.h {0}/ranges.h {0}/std.h \
{0}/xchar.h
QUIET = YES QUIET = YES
JAVADOC_AUTOBRIEF = NO JAVADOC_AUTOBRIEF = NO
AUTOLINK_SUPPORT = NO AUTOLINK_SUPPORT = NO
@ -116,16 +117,16 @@ class CxxHandler(BaseHandler):
paren = name.find('(') paren = name.find('(')
param_str = None param_str = None
if paren > 0: if paren > 0:
name, param_str = name[:paren], name[paren:] name, param_str = name[:paren], name[paren + 1:-1]
nodes = self._doxyxml.findall( nodes = self._doxyxml.findall(
f"compounddef/sectiondef/memberdef/name[.='{name}']/..") f"compounddef/sectiondef/memberdef/name[.='{name}']/..")
candidates = [] candidates = []
for node in nodes: for node in nodes:
params = [convert_param(p) for p in node.findall('param')] params = [convert_param(p) for p in node.findall('param')]
node_param_str = '(' + ', '.join([p.type for p in params]) + ')' node_param_str = ', '.join([p.type for p in params])
if param_str and param_str != node_param_str: if param_str and param_str != node_param_str:
candidates.append(name + node_param_str) candidates.append(f'{name}({node_param_str})')
continue continue
d = Decl(name) d = Decl(name)
d.type = node.find('type').text d.type = node.find('type').text
@ -147,8 +148,8 @@ class CxxHandler(BaseHandler):
def render(self, d: Decl, config: dict) -> str: def render(self, d: Decl, config: dict) -> str:
text = '<pre><code>' text = '<pre><code>'
text += d.type + ' ' + d.name text += d.type + ' ' + d.name
if d.params: if d.params is not None:
params = ', '.join([p.type for p in d.params]) params = ', '.join([p.type + ' ' + p.name for p in d.params])
text += '(' + params + ')' text += '(' + params + ')'
text += ';' text += ';'
text += '</code></pre>\n' text += '</code></pre>\n'