GNOME Bugzilla – Bug 782583
Generate man page includes both page name and title
Last modified: 2018-07-30 10:45:04 UTC
If you have /** @page page_name Title do something. */ The generated man page will have NAME page_nameTitle - do something. If you omit the title /** @page page_name Do something */ then the man page looks reasonable NAME page_name - do something. but the HTML version will not have a title so it starts with just "do something."
page_name is used as the name of the man page file so the solution is to omit Title from the man page and only use it in the HTML version as the command "man page_name" would be expected to bring up a man page with NAME man_page. If you use Title there is a chance of generating a page such that "man foo" brings up a page for "Bar". Meanwhile in HTML-land the generated page does not have a NAME section heading under any circumstance so looks different from the man page. "Title" is written in a box at the top of page, or if Title is omitted, there's an empty box.
When the title is omitted, the HTML title of the page will be "Project Name: $title" where "Project Name" is the value of the PROJECT_NAME property in the Doxygen config file.
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!