GNOME Bugzilla – Bug 744755
doxygen ignores main header in mainpage when using markdown
Last modified: 2018-07-30 09:59:29 UTC
The first header in the mainpage will not be displayed when output is HTML. Instead it will be display the default title: "$project_name Documentation" The feature is described here: www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_page_header Doesn't work with the 1.8.9 version of doxygen Also labeling of subheaders will make them disappear within the mainpage.
I forgot to say the mainpage is an *.md file, so I set the option: USE_MDFILE_AS_MAINPAGE =main_page.md The header is in format like in the docu: My Main Page {#mainpage} ============
Created attachment 303653 [details] Example for behaviour described in comment. Generally, behaviour of USE_MDFILE_AS_MAINPAGE is hard to determine. One would assume, that in example given in attachment, on the mainpage I would see the string "This is main md file". Unfortunately, there is nothing. However, when you run following command to add md files in subdirectories: for p in foo bar baz; do echo "this is readme.md in $p" > $p/readme.md; done and rerun the doxygen, the "this is readme.md in foo" appears on the main page. Also the warning appears during processing: /tmp/md/bar/readme.md:1: warning: found more than one \mainpage comment block! Skipping this block. It get worse when you are starting to use the @addtogroup in the file. So, generally, however USE_MDFILE_AS_MAINPAGE is a neat idea and I would like to use it in my project, it's hardly usable at all. What I ask for is to make it simple: value of this parameter is just a path to the file to incorporate into main page. That's all.
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to https://github.com/doxygen/doxygen/issues All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github. Hence I am closing this GNOME Bugzilla ticket. Please use the corresponding ticket in Github instead. Thanks a lot!