Internships/ProjectIdeas/APIDocumentationGeneration

From QEMU
Revision as of 18:50, 21 January 2019 by Ehabkost (talk | contribs) (Created page with "=== API documentation generation === '''Summary:''' Generation of API documentation from doc comments QEMU currently has many functions documented using the GTK-Doc syntax,...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

API documentation generation

Summary: Generation of API documentation from doc comments

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 build rules that generate API documentation from C and Python source code.

Tasks:

  • Picking a documentation generation tool and syntax (unclear if we should stay with GTK-Doc)
  • Fixing or converting existing doc comments to the chosen syntax
  • Writing build rules to generate the documentation
  • Extra tasks, if time allows:
    • Improving clarity or formatting of existing doc comments
    • Converting existing ad-hoc comments in the code to doc comment syntax
    • Add doc comments to existing APIs that are undocumented


Links:

Details:

  • Skill level: beginner
  • Language: C, Python
  • Mentor: Eduardo Habkost <ehabkost@redhat.com> ("ehabkost" on IRC)
  • Suggested by: Eduardo Habkost
Retrieved from "https://wiki.qemu.org/index.php?title=Internships/ProjectIdeas/APIDocumentationGeneration&oldid=8116"