Internships/ProjectIdeas/APIDocumentationGeneration

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

API documentation generation

Status: Gabriel Barreto is working on this project for GSoC.

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, GNU Make
Mentor: Eduardo Habkost <ehabkost@redhat.com> ("ehabkost" on IRC)
Suggested by: Eduardo Habkost