stdcxx-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Elmar Zander (JIRA)" <j...@apache.org>
Subject [jira] Created: (STDCXX-1025) Documentation for ios_base::flags and ios_base::setf misleading
Date Thu, 20 Nov 2008 08:32:44 GMT
Documentation for ios_base::flags and ios_base::setf misleading
---------------------------------------------------------------

                 Key: STDCXX-1025
                 URL: https://issues.apache.org/jira/browse/STDCXX-1025
             Project: C++ Standard Library
          Issue Type: Bug
          Components: Web Site
            Reporter: Elmar Zander
            Priority: Minor


The documentation says for boths "flags(fmtflags fmtfl)" and "setf(fmtflags fmtfl)" exactly
the same, which is not true:

flags(fmtflags fmtfl); 
      Saves the format control information, then sets it to fmtfl and returns the previously
saved value.

setf(fmtflags fmtfl); 
      Saves the format control information, then sets it to fmtfl and returns the previously
saved value.

The documentation in the header file "ios_base.h" is indeed better. It states for flags:
> This function overwrites all the format flags with @a fmtfl.
while for setf it says:
> This function sets additional flags in format control.  Flags that were previously set
remain set.

BTW: The start of the sentences "Saves the format control information..." is confusing anyway
and not necessary for anyone using this interface. It's enough to know that the function "returns
the previously saved value".


-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message