|
|
| (14 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| = Drafts =
| |
|
| |
|
| === 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 tools to
| |
| generate API documentation from C and Python source code.
| |
|
| |
| '''Links:'''
| |
| * [https://lists.gnu.org/archive/html/qemu-devel/2011-12/msg01803.html series from 2011 for gtk-doc build integration]
| |
| * [https://www.mail-archive.com/qemu-devel@nongnu.org/msg411643.html discussion about Sphinx vs gtk-doc]
| |
| * [https://www.gtk.org/gtk-doc/ GTK-Doc Project]
| |
|
| |
| '''Details:'''
| |
| * Skill level: beginner
| |
| * Language: C, Python
| |
| * Mentor: Eduardo Habkost <ehabkost@redhat.com>, ehabkost
| |
| * Suggested by: Eduardo Habkost
| |
