Add doxygen documentation to the C library
commitc88c1173e46ad481c14c1fa97765d6c27e59d36d
authorAlberto Bertogli <albertito@blitiri.com.ar>
Thu, 16 Apr 2009 19:06:15 +0000 (16 16:06 -0300)
committerAlberto Bertogli <albertito@blitiri.com.ar>
Sat, 18 Apr 2009 00:34:23 +0000 (17 21:34 -0300)
treee152bf2de75b1f959cca085025d5754331fa5647
parentf318eae1ae5152ebbf70e67e2dec5919a104ed81
Add doxygen documentation to the C library

This patch adds doxygen documentation to the C library, and the Makefile
targets to generate it.

It generates two documentation sets: public, containing only the public
API, and internal containing all the library elements.

Almost all the public API has been fully documented, and most internal
function now have at least a basic description.

While at it, several comments were improved both in content and style.

Signed-off-by: Alberto Bertogli <albertito@blitiri.com.ar>
18 files changed:
.gitignore
libjio/Doxyfile.base [new file with mode: 0644]
libjio/Doxyfile.internal [new file with mode: 0644]
libjio/Doxyfile.public [new file with mode: 0644]
libjio/Makefile
libjio/ansi.c
libjio/autosync.c
libjio/check.c
libjio/checksum.c
libjio/common.c
libjio/common.h
libjio/compat.c
libjio/compat.h
libjio/journal.c
libjio/libjio.h
libjio/trans.c
libjio/trans.h
libjio/unix.c