New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate man page includes both page name and title (Origin: bugzilla #782583) #6210

Open
doxygen opened this Issue Jul 2, 2018 · 1 comment

Comments

Projects
None yet
3 participants
@doxygen
Owner

doxygen commented Jul 2, 2018

status NEW severity normal in component general for ---
Reported in version 1.8.13 on platform Other
Assigned to: Dimitri van Heesch

On 2017-05-13 05:29:42 +0000, gnome.org@erewhon0.net wrote:

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."

On 2017-05-13 05:40:02 +0000, gnome.org@erewhon0.net wrote:

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.

On 2017-05-14 07:04:11 +0000, gnome.org@erewhon0.net wrote:

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.
@MarkCallow

This comment has been minimized.

Contributor

MarkCallow commented Jul 30, 2018

This issue can be closed. My accepted PR with the fix is now cross-referenced.

No close button is appearing for me, presumably because I'm not recognized as the reporter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment