GNOME Bugzilla – Bug 646428
The generated man pages has a .PP just before the subject description.
Last modified: 2013-04-18 10:13:01 UTC
Created attachment 184861 [details] 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.
Created attachment 238464 [details] [review] 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,
Thanks, I'll include the patch in the next subversion update.
Thank you very much! Now it works!