def subst_strong(doc):
"""Replaces *foo* by @strong{foo}"""
- return re.sub(r'\*([^*\n]+)\*', r'@emph{\1}', doc)
+ return re.sub(r'\*([^*\n]+)\*', r'@strong{\1}', doc)
def subst_emph(doc):
"""Replaces _foo_ by @emph{foo}"""
- return re.sub(r'\b_([^_\n]+)_\b', r' @emph{\1} ', doc)
+ return re.sub(r'\b_([^_\n]+)_\b', r'@emph{\1}', doc)
def subst_vars(doc):
# doesn't.
#
# Make sure to update section "Documentation markup" in
- # docs/qapi-code-gen.txt when fixing this.
+ # docs/devel/qapi-code-gen.txt when fixing this.
if line.startswith('| '):
line = EXAMPLE_FMT(code=line[2:])
elif line.startswith('= '):
def texi_enum_value(value):
"""Format a table of members item for an enumeration value"""
- return "@item @code{'%s'}\n" % value.name
+ return '@item @code{%s}\n' % value.name
-def texi_member(member):
+def texi_member(member, suffix=''):
"""Format a table of members item for an object type member"""
- return "@item @code{'%s'}%s\n" % (
- member.name, ' (optional)' if member.optional else '')
+ typ = member.type.doc_type()
+ return '@item @code{%s%s%s}%s%s\n' % (
+ member.name,
+ ': ' if typ else '',
+ typ if typ else '',
+ ' (optional)' if member.optional else '',
+ suffix)
-def texi_members(doc, member_func, show_undocumented):
+def texi_members(doc, what, base, variants, member_func):
"""Format the table of members"""
items = ''
for section in doc.args.itervalues():
- if not section.content and not show_undocumented:
- continue # Undocumented TODO require doc and drop
- desc = str(section)
- items += member_func(section.member) + texi_format(desc) + '\n'
+ # TODO Drop fallbacks when undocumented members are outlawed
+ if section.content:
+ desc = texi_format(str(section))
+ elif (variants and variants.tag_member == section.member
+ and not section.member.type.doc_type()):
+ values = section.member.type.member_names()
+ desc = 'One of ' + ', '.join(['@t{"%s"}' % v for v in values])
+ else:
+ desc = 'Not documented'
+ items += member_func(section.member) + desc + '\n'
+ if base:
+ items += '@item The members of @code{%s}\n' % base.doc_type()
+ if variants:
+ for v in variants.variants:
+ when = ' when @code{%s} is @t{"%s"}' % (
+ variants.tag_member.name, v.name)
+ if v.type.is_implicit():
+ assert not v.type.base and not v.type.variants
+ for m in v.type.local_members:
+ items += member_func(m, when)
+ else:
+ items += '@item The members of @code{%s}%s\n' % (
+ v.type.doc_type(), when)
if not items:
return ''
- return '@table @asis\n' + items + '@end table\n'
+ return '\n@b{%s:}\n@table @asis\n%s@end table\n' % (what, items)
def texi_sections(doc):
return body
-def texi_entity(doc, member_func=texi_member, show_undocumented=False):
+def texi_entity(doc, what, base=None, variants=None,
+ member_func=texi_member):
return (texi_body(doc)
- + texi_members(doc, member_func, show_undocumented)
+ + texi_members(doc, what, base, variants, member_func)
+ texi_sections(doc))
self.out += '\n'
self.out += TYPE_FMT(type='Enum',
name=doc.symbol,
- body=texi_entity(doc,
- member_func=texi_enum_value,
- show_undocumented=True))
+ body=texi_entity(doc, 'Values',
+ member_func=texi_enum_value))
def visit_object_type(self, name, info, base, members, variants):
doc = self.cur_doc
- if not variants:
- typ = 'Struct'
- elif variants._tag_name: # TODO unclean member access
- typ = 'Flat Union'
- else:
- typ = 'Simple Union'
+ if base and base.is_implicit():
+ base = None
if self.out:
self.out += '\n'
- self.out += TYPE_FMT(type=typ,
+ self.out += TYPE_FMT(type='Object',
name=doc.symbol,
- body=texi_entity(doc))
+ body=texi_entity(doc, 'Members', base, variants))
def visit_alternate_type(self, name, info, variants):
doc = self.cur_doc
self.out += '\n'
self.out += TYPE_FMT(type='Alternate',
name=doc.symbol,
- body=texi_entity(doc))
+ body=texi_entity(doc, 'Members'))
def visit_command(self, name, info, arg_type, ret_type,
gen, success_response, boxed):
doc = self.cur_doc
if self.out:
self.out += '\n'
+ if boxed:
+ body = texi_body(doc)
+ body += '\n@b{Arguments:} the members of @code{%s}' % arg_type.name
+ body += texi_sections(doc)
+ else:
+ body = texi_entity(doc, 'Arguments')
self.out += MSG_FMT(type='Command',
name=doc.symbol,
- body=texi_entity(doc))
+ body=body)
def visit_event(self, name, info, arg_type, boxed):
doc = self.cur_doc
self.out += '\n'
self.out += MSG_FMT(type='Event',
name=doc.symbol,
- body=texi_entity(doc))
+ body=texi_entity(doc, 'Arguments'))
def symbol(self, doc, entity):
self.cur_doc = doc
if not qapi.doc_required:
print >>sys.stderr, ("%s: need pragma 'doc-required' "
"to generate documentation" % argv[0])
+ sys.exit(1)
print texi_schema(schema)
projects / qemu.git / blobdiff