doc: use README as doxygen main page overview
authorRan Benita <ran234@gmail.com>
Tue, 5 Mar 2013 11:16:30 +0000 (13:16 +0200)
committerDaniel Stone <daniel@fooishbar.org>
Mon, 18 Mar 2013 22:20:06 +0000 (22:20 +0000)
commite8c0396f9764d6fba94c806e1dd9abb86652421e
treea51a42258cbc602e010143baffbd931bdef09d5d
parent40e5de9ac4a6f9a115605ded8286771fb3d975bd
doc: use README as doxygen main page overview

The doxygen page looked a bit dead, the README fills it nicely, and is
already written in the markdown format which doxygen uses (I think?).

Unfortunately the USE_MDFILE_AS_MAINPAGE doxygen config doesn't seem to
do anything.. So we just add a {#mainpage} tag at the top of the README
which isn't so bad. BUT we still need some config option (the
no_extension=md part) so that doxygen will accept README instead of
README.md or somesuch. And that requires an even newer release, 1.8.3.1,
released 2013-01. But if an older version is used, it doesn't spew out
warnings but just skips the README, which is fine.

Signed-off-by: Ran Benita <ran234@gmail.com>
README
doc/Doxyfile.in