docs: Use doxygen config to mark the main page
authorAtish Patra <atish.patra@wdc.com>
Fri, 5 Jun 2020 06:31:48 +0000 (23:31 -0700)
committerAnup Patel <anup@brainfault.org>
Mon, 8 Jun 2020 11:32:41 +0000 (17:02 +0530)
commit79bfd67f9a2ed5cae966b72cc2a72f68824c4ab8
tree73e7a8250d4e7a6f4172354bf43392f75bce473b
parent1b8c0128f1d79d69ea0a46b758fef4be8dc0a73e
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>
README.md
docs/doxygen.cfg