GNOME Bugzilla – Bug 654870
Manpages don't contain a short description
Last modified: 2018-07-30 10:40:48 UTC
When generating manpages, the NAME line consists of the name, followed by a - and then nothing. It should be followed by the short description. This is important because apropos (aka man -k) searches through and displays these parts. The syntax already allows providing both a short and a long description. The short description of the object of which the file is made (for example the C++ class) should be used here. I checked the source to see if I was doing something wrong. In mangen.cpp:endTitleHead is the code that outputs the parts I'm seeing. It does leave room for the missing part, since the final newline is not printed. I'm not sure what comes after that, the code is too complicated to quickly see. It seems some "intro" text is printed, but I can't find anywhere where that would be defined.
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!