boostorg/io
1
0
Fork 1
mirror of https://github.com/boostorg/io.git synced 2025-07-29 20:07:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Minor documentation changes

Browse Source
This commit is contained in:
Glen Fernandes
2019-12-17 20:35:58 -05:00
parent c761bbc285
commit 980cebe39e
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/ios_state.adoc
View File

@ -109,13 +109,14 @@ The basic saver classes have this format:
[subs=+quotes] [subs=+quotes]
``` ```
class saver_class { class saver {
public:
typedef std::ios_base state_type; typedef std::ios_base state_type;
typedef `implementation_defined` aspect_type; typedef `implementation_defined` aspect_type;
explicit saver_class(state_type& s); explicit saver(state_type& s);
saver_class(state_type& s, const aspect_type& new_value); saver(state_type& s, const aspect_type& new_value);
~saver_class(); ~saver();
void restore(); void restore();
}; };
@ -159,13 +160,14 @@ The saver class templates have this format:
[subs=+quotes] [subs=+quotes]
``` ```
template<class Ch, class Tr> template<class Ch, class Tr>
class saver_class { class saver {
public:
typedef std::basic_ios<Ch, Tr> state_type; typedef std::basic_ios<Ch, Tr> state_type;
typedef `implementation-defined` aspect_type; typedef `implementation-defined` aspect_type;
explicit saver_class(state_type& s); explicit saver(state_type& s);
saver_class(state_type& s, const aspect_type& new_value); saver(state_type& s, const aspect_type& new_value);
~saver_class(); ~saver();
void restore(); void restore();
}; };
@ -259,7 +261,7 @@ The code used in the rationale can be improved at two places. The printing
function could use a saver around the code that changes the formatting state. function could use a saver around the code that changes the formatting state.
Or the calling function can surround the call with a saver. Or both can be Or the calling function can surround the call with a saver. Or both can be
done, especially if the user does not know if the printing function uses a done, especially if the user does not know if the printing function uses a
state saver. If the user wants a series of changes back & forth, without state saver. If the user wants a series of changes back and forth, without
surrounding each change within a separate block, the restore member function surrounding each change within a separate block, the restore member function
can be called between each trial. can be called between each trial.