summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRan Benita <ran234@gmail.com>2013-03-05 13:16:30 +0200
committerDaniel Stone <daniel@fooishbar.org>2013-03-18 22:20:06 +0000
commite8c0396f9764d6fba94c806e1dd9abb86652421e (patch)
treea51a42258cbc602e010143baffbd931bdef09d5d /doc
parent40e5de9ac4a6f9a115605ded8286771fb3d975bd (diff)
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile.in4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index e2b76c0..a63db25 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -241,7 +241,7 @@ OPTIMIZE_OUTPUT_VHDL = NO
# that for custom extensions you also need to set FILE_PATTERNS otherwise the
# files are not read by doxygen.
-EXTENSION_MAPPING =
+EXTENSION_MAPPING = no_extension=md
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
# comments according to the Markdown format, which allows for more readable
@@ -668,7 +668,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = @abs_top_srcdir@/xkbcommon
+INPUT = @abs_top_srcdir@/xkbcommon @abs_top_srcdir@/README
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is