[Bug libstdc++/42460] man page errors for generated libstdc++ man pages

["doko at ubuntu dot com" <gcc-bugzilla@gcc.gnu.org>]

------- Comment #13 from doko at ubuntu dot com  2010-01-21 14:30 -------
std::basic_ios.3, std::basic_ofstream.3, std::basic_ostream.3,
std::basic_ostringstream.3, std::ios_base.3:

.PP
Definition at line 657 of file ios_base.h.
.SS "\fBstreamsize\fP std::ios_base::width () const\fC [inline, inherited]\fP"
.PP
Flags access. \fBReturns:\fP
.RS 4
The minimum field width to generate on output operations.
.RE
.PP
'Minimum field width' refers to the number of characters. 
.PP

The ' should be escaped as \', or else the paragraph is just discarded; unsure
how this should be formatted (quoting as \" for doxygen?). other places are
quotations from the standard, like:

src/libstdc++-v3/include/std/streambuf

       *  'If it returns a positive value, then successive calls to
       *  @c underflow() will not return @c traits::eof() until at least that
       *  number of characters have been supplied.  If @c showmanyc()
       *  returns -1, then calls to @c underflow() or @c uflow() will fail.'
       *  [27.5.2.4.3]/1

Extraction into another streambuf. \fBParameters:\fP
.RS 4
\fIsb\fP A streambuf in which to store data. 
.RE
.PP
\fBReturns:\fP
.RS 4
*this
.RE
.PP
Returns \fCget\fP(sb,widen('
.br
')). 
.PP
Definition at line 365 of file istream.

libstdc++-v3/include/std/istream

       *  Returns @c get(sb,widen('\n')).

unqoted quote and unqoted backslash, so make this "\\\"\? There are other
places.


std::linear_congruential_engine.3
A random number generator that produces pseudorandom numbers using the linear
function $x_{i+1}\leftarrow(ax_{i} + c) \bmod m $.

std::exponential_distribution.3
The formula for the exponential probability density function is $ p(x|\lambda)
= \lambda e^{-\lambda x} $.

Tex is used instead of eqn. Didn't see a directive to not include this not for
the manpages.

So far, no bad checks from the checker, these all look like real problems.


-- 


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=42460

------- You are receiving this mail because: -------
You reported the bug, or are watching the reporter.