doc: fix API index
authorThomas Monjalon <thomas@monjalon.net>
Tue, 26 May 2020 20:29:20 +0000 (22:29 +0200)
committerDavid Marchand <david.marchand@redhat.com>
Thu, 28 May 2020 09:10:41 +0000 (11:10 +0200)
commit60814f955cfdebeb1d7bb3c8c5ae6c566b15f572
tree46609285a14257bd5462c26afb734a7aac4e1e46
parent27991115743bc0e1feb2c4ba7a766020d51bdb5d
doc: fix API index

With Doxygen 1.8.18, a warning appears when tagging
the main markdown header with {#index}.
That's why the tag has been removed from the API index in DPDK 20.05.
Unfortunately it makes the index page classified as a standard
"related page" instead of being the "main page".

The tag {#mainpage} could be used instead of {#index}.
Another solution, chosen here, is to specify the main page file
in the Doxygen configuration with the variable USE_MDFILE_AS_MAINPAGE.

Fixes: 76fb8fc486f9 ("doc: fix build with doxygen 1.8.18")
Cc: stable@dpdk.org
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Tested-by: David Marchand <david.marchand@redhat.com>
doc/api/doxy-api.conf.in