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

The generated man pages has a .PP just before the subject description. (Origin: bugzilla #646428) #4223

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity trivial in component general for ---
Reported in version 1.7.2 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2011-04-01 11:16:19 +0000, Manuel L. Pereira García wrote:

Created attachment 184861
A doxygen configuration file and a code file which can help to find the bug.

Good morning:

\copydoc Summary. ;)

This is not only a pretty-printer bug, but also a problem for searching documentation, because man use the short description to search for pages.

In the example the problem can be observed by following the next steps:

1.- Go to the directory where you have untargz the example.
1.- Run doxygen.
2.- Set the generated man directory on MANPATH environment variable (on bash, type "export MANPATH=$(pwd)/man:$MANPATH").
3.- Go to the generated man directory and run mandb.
4.- Search for a manpage which talks about main.c (man -k main.c).
---> It appears a line: "main.c - (unknown subject)".
5.- Search for a manpage which talks about place (man -k place).
---> It not appears "main.c - ...".
6.- Now delete in the generated manpage main.c.3 the .PP instruction just before the brief file description ("The place where the bug is showed").
7.- Re-run mandb. It will report that has added a manpage.
8.- Repeat steps 4 and 5. Now in 4 appears the brief file description and in 5 appears the main.c entry.

Thank you very much for your attention and for your work.

Carefully,
Manuel L. Pereira García.

On 2013-03-09 18:30:30 +0000, albert wrote:

Created attachment 238464
PATCH: get brief description on first line

Adjusting initial definition of paragraph for man documentation. First paragraph is always the NAME and the description should directly follow the module / file name. Value has to be reset after each .SH NAME as it is used on each page,

On 2013-03-31 13:24:24 +0000, Dimitri van Heesch wrote:

Thanks, I'll include the patch in the next subversion update.

On 2013-04-18 10:13:01 +0000, Manuel L. Pereira García wrote:

Thank you very much! Now it works!

@doxygen doxygen closed this Jul 2, 2018

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