From: Rafał Długołęcki <rafal@dlugolecki.net.pl>
Date: Mon, 25 Jul 2016 18:11:21 +0000 (+0200)
Subject: Use README.md file as main page for Doxygen documentation
X-Git-Url: https://git.dlugolecki.net.pl/?a=commitdiff_plain;ds=inline;p=command.git

Use README.md file as main page for Doxygen documentation
---

diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
index 79b033b..dedd915 100644
--- a/docs/Doxyfile.in
+++ b/docs/Doxyfile.in
@@ -753,7 +753,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @top_srcdir@/include
+INPUT                  = @top_srcdir@/include @top_srcdir@/README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -773,7 +773,7 @@ INPUT_ENCODING         = UTF-8
 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
 # *.qsf, *.as and *.js.
 
-FILE_PATTERNS          = *.h
+FILE_PATTERNS          = *.h *.md
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -889,7 +889,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing