]> git.alsa-project.org Git - alsa-python.git/commit
alsa-python: API coverage documentation tool
authorTakashi Iwai <tiwai@suse.de>
Tue, 18 Mar 2008 17:20:32 +0000 (18:20 +0100)
committerTakashi Iwai <tiwai@suse.de>
Tue, 18 Mar 2008 17:20:32 +0000 (18:20 +0100)
commita5d547ee51e6d7094a93b3163ac7428f7c5d7f19
tree7476367d002b4d8b00692278f45bfe1ee99c7190
parentac07d0777e85c94014a109fb1112a4985369475c
alsa-python: API coverage documentation tool

The following patch is a python tool that shows how much of the
asoundlib API is being covered by the alsa-python binding. It works by
parsing the C source code and comparing with the official Doxygen
documentation from alsa website.

It will help the following users:
- alsa-python developers: know how is mapped the original C API, so
which python function/variable may be used.
- python binding developers: know how much of the C API is covered. It
could help for mistakes (free() instead of using
snd_ctl_card_info_free), know what is missing, and statistic interest ;)

From: Aldrin Martoq <amartoq@dcc.uchile.cl>
.hgignore
doc/APICoverage.py [new file with mode: 0644]
doc/alsa-python-coverage.py [new file with mode: 0755]