From 60814f955cfdebeb1d7bb3c8c5ae6c566b15f572 Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Tue, 26 May 2020 22:29:20 +0200 Subject: [PATCH] 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 Tested-by: David Marchand --- doc/api/doxy-api.conf.in | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in index 92122125ae..9b55b7500c 100644 --- a/doc/api/doxy-api.conf.in +++ b/doc/api/doxy-api.conf.in @@ -3,6 +3,7 @@ PROJECT_NAME = DPDK PROJECT_NUMBER = @VERSION@ +USE_MDFILE_AS_MAINPAGE = @TOPDIR@/doc/api/doxy-api-index.md INPUT = @TOPDIR@/doc/api/doxy-api-index.md \ @TOPDIR@/drivers/bus/vdev \ @TOPDIR@/drivers/crypto/scheduler \ -- 2.20.1