]> git.ipfire.org Git - thirdparty/json-c.git/commit
doc: Use other doxygen feature to specify mainpage 387/head
authorAlexander Dahl <post@lespocky.de>
Mon, 11 Dec 2017 08:46:28 +0000 (09:46 +0100)
committerAlexander Dahl <post@lespocky.de>
Mon, 11 Dec 2017 08:46:28 +0000 (09:46 +0100)
commit89747ac75892b58c6c8c4de36dfbcec0f547db95
treee567a90a7929d837218cf81e97221a81fcc9af1b
parenta19031411ddcc3d9a0cc79bef8ab17efb33ea8fd
doc: Use other doxygen feature to specify mainpage

Previously a special tag was added to README.md to make this the
main page in Doxygen generated docs. When viewing the README on the
GitHub page this tag was not hidden.

After upgrading to Doxygen 1.8.8 (and above) in changeset
219025727dd7d981cf2fea7f2095570924e7bae7 a new Doxygen feature can be
used to specify the main page: Since release 1.8.3 Doxygen has a special
option to set a markdown file as main page. When using this option we
can drop the tag, making the README rendered by GitHub nice to look at.

Fixes: ae66b243690871f2daea5ae4b2a4669081d7c556
Doxyfile
README.md