From af057d8c4999e6e64756837e76be9ddaed0dc918 Mon Sep 17 00:00:00 2001 From: Martin Read Date: Mon, 28 Feb 2011 10:55:02 +0000 Subject: [PATCH] Updated stlprintf man page and header --- include/libmormegil/stlprintf.hh | 2 +- man/libmormegil::stlprintf.3 | 15 ++++++++------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/include/libmormegil/stlprintf.hh b/include/libmormegil/stlprintf.hh index 3378098..90d99f8 100644 --- a/include/libmormegil/stlprintf.hh +++ b/include/libmormegil/stlprintf.hh @@ -29,7 +29,7 @@ #include #include -namespace libmrl +namespace libmormegil { extern std::string vstlprintf(const char *fmt, va_list args); extern std::string stlprintf(const char *fmt, ...); diff --git a/man/libmormegil::stlprintf.3 b/man/libmormegil::stlprintf.3 index 855f3da..10a7fb4 100644 --- a/man/libmormegil::stlprintf.3 +++ b/man/libmormegil::stlprintf.3 @@ -1,5 +1,4 @@ - -.TH "LIBMORMEGIL::STLPRINTF" 3 "October 23, 2010" "libmormegil Version 1.0" "libmormegil User Manual" +.TH "LIBMORMEGIL::STLPRINTF" 3 "February 25, 2011" "libmormegil Version 1.0" "libmormegil User Manual" .SH NAME libmormegil::stlprintf, libmormegil::vstlprintf \- sprintf-alikes for std::string .SH SYNOPSIS @@ -11,11 +10,14 @@ are equivalent to the standard C library's \fIsprintf\fP and \fIvsprintf\fP functions, but operate on the standard C++ library's \fIstd::string\fP class rather than on C-style strings. -.SH CAVEATS +.SH RETURNS +Both functions return a \fIstd::string\fP object containing the formatted +output. -These functions resolve down to a call to the local implementation of vsprintf. -All bugs, health hazards, and other concerns which apply to the local vsprintf -apply to +.SH CAVEATS +These functions are wrapped around your system's local implementation of +vsprintf. All bugs, health hazards, and other concerns which apply to the +local vsprintf apply to these functions as well. .SH AUTHOR Stefan O'Rear @@ -23,5 +25,4 @@ Stefan O'Rear Amendments were made by Martin Read in order to fit into libmormegil. .SH SEE ALSO - libmormegil(3), vsprintf(3) -- 2.11.0