Talk:Google Summer of Code 2019: Difference between revisions

From QEMU
(Created page with "= Drafts = === API documentation generation === '''Summary:''' Generation of API documentation from doc comments QEMU currently has many functions documented using the GTK-...")
 
Line 3: Line 3:
=== API documentation generation ===
=== API documentation generation ===


'''Summary:''' Generation of API documentation from doc comments
'''Summary:'''


QEMU currently has many functions documented using the GTK-Doc
QEMU currently has many functions documented using the GTK-Doc

Revision as of 19:33, 16 January 2019

Drafts

API documentation generation

Summary:

QEMU currently has many functions documented using the GTK-Doc syntax, but there is no mechanism to actually generate API documentation from these doc comments. We need tools to generate API documentation from C and Python source code.

Links:

Details:

  • Skill level: beginner
  • Language: C, Python
  • Mentor: Eduardo Habkost <ehabkost@redhat.com>, ehabkost
  • Suggested by: Eduardo Habkost