From 79bfd67f9a2ed5cae966b72cc2a72f68824c4ab8 Mon Sep 17 00:00:00 2001
From: Atish Patra <atish.patra@wdc.com>
Date: Thu, 4 Jun 2020 23:31:48 -0700
Subject: docs: Use doxygen config to mark the main page

The doxygen config option "USE_MDFILE_AS_MAINPAGE" can be used to set
the main page in doxygen generated pdf. This allows us to remove the
"#mainpage" from the README file which markdown doesn't parse.

Signed-off-by: Atish Patra <atish.patra@wdc.com>
Reviewed-by: Anup Patel <anup.patel@wdc.com>
---
 docs/doxygen.cfg | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/doxygen.cfg')

diff --git a/docs/doxygen.cfg b/docs/doxygen.cfg
index f32ada1..dbf8ef9 100644
--- a/docs/doxygen.cfg
+++ b/docs/doxygen.cfg
@@ -949,7 +949,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
-- 
cgit v1.2.3