[jira] Updated: (STDCXX-1025) Documentation for ios_base::flags and ios_base::setf misleading

["Martin Sebor (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/STDCXX-1025?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Martin Sebor updated STDCXX-1025:
---------------------------------

           Component/s:     (was: Web Site)
                        Documentation
              Severity: Usability  (was: Incorrect Behavior)
     Affects Version/s: 4.2.1
         Fix Version/s: 4.2.2
              Assignee: Martin Sebor
    Remaining Estimate: 1h
     Original Estimate: 1h

> 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: Documentation
>    Affects Versions: 4.2.1
>            Reporter: Elmar Zander
>            Assignee: Martin Sebor
>            Priority: Minor
>             Fix For: 4.2.2
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> 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.