GNOME Bugzilla – Bug 652277
Full stops in first column need to be escaped in man page output
Last modified: 2011-12-03 18:22:50 UTC
The following mark up: /** @page installation How to install @brief This section describes the installation process To intall the software do @code tar -zxf code-1.0.tar.gz cd code-1.0 autoreconf -f ./configure make make install @endcode */ generates a man page that when view with man looks like: NAME installation - How to install This section describes the installation process To intall the software do tar -zxf code-1.0.tar.gz cd code-1.0 autoreconf -f make make install As can be seen the line "./configure" is not displayed. The line is present in the generated man page, but man uses periods in the first column to indicate a macro - so man treats the line as on undefined macro and displays nothing. PS. Should really both the page title and the brief description be displayed on the first line to the right of the hyphen? It think this looks odd.
Debian's lintian says about this: N: This test uses man's --warnings option to enable groff warnings that N: catch common mistakes, such as putting . or ' characters at the start of N: a line when they are intended as literal text rather than groff N: commands. This can be fixed either by reformatting the paragraph so that N: these characters are not at the start of a line, or by adding a N: zero-width space (\&) immediately before them.
(In reply to comment #1) > Debian's lintian says about this: > > N: This test uses man's --warnings option to enable groff warnings that > N: catch common mistakes, such as putting . or ' characters at the start of > N: a line when they are intended as literal text rather than groff > N: commands. This can be fixed either by reformatting the paragraph so that > N: these characters are not at the start of a line, or by adding a > N: zero-width space (\&) immediately before them. Thanks for the tip. This works fine.
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.7.5. Please verify if this is indeed the case. Reopen the bug if you think it is not fixed and please include any additional information that you think can be relevant.
Created attachment 194917 [details] [review] Remove single quote in output when writing a dot I get the impression that the ' (single quote) should not be in the filter subroutine in mandocvisitor.cpp
Indeed. I'll take over the patch.
Ah sorry, I just submitted this same patch in Bug#659514
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.7.6. Please verify if this is indeed the case. Reopen the bug if you think it is not fixed and please include any additional information that you think can be relevant.