diff options
| author | Atish Patra <atish.patra@wdc.com> | 2020-06-04 23:31:48 -0700 |
|---|---|---|
| committer | Anup Patel <anup@brainfault.org> | 2020-06-08 17:02:41 +0530 |
| commit | 79bfd67f9a2ed5cae966b72cc2a72f68824c4ab8 (patch) | |
| tree | 73e7a8250d4e7a6f4172354bf43392f75bce473b /docs | |
| parent | 1b8c0128f1d79d69ea0a46b758fef4be8dc0a73e (diff) | |
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>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/doxygen.cfg | 2 |
1 files changed, 1 insertions, 1 deletions
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 |