Skip to content

Commit 2b229f7

Browse files
committed
Update documentation
1 parent 8febad4 commit 2b229f7

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

doc/uuid/string_generator.adoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ struct string_generator
1414
{
1515
using result_type = uuid;
1616
17-
template<class Ch, class Traits, class Alloc>
18-
constexpr uuid operator()( std::basic_string<Ch, Traits, Alloc> const& s ) const;
17+
template<class Str>
18+
constexpr uuid operator()( Str const& s ) const;
1919
2020
template<class Ch>
2121
constexpr uuid operator()( Ch const* s ) const;
@@ -55,11 +55,14 @@ hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
5555
Invalid input will generate a `std::runtime_error` exception.
5656

5757
```
58-
template<class Ch, class Traits, class Alloc>
59-
constexpr uuid operator()( std::basic_string<Ch, Traits, Alloc> const& s ) const;
58+
template<class Str>
59+
constexpr uuid operator()( Str const& s ) const;
6060
```
6161

62-
Requires: :: The character type `Ch` of `s` must be one of `char`, `wchar_t`, `char8_t`, `char16_t`, `char32_t`.
62+
Requires: ::
63+
`Str` must be a _string-like_ type; that is, one with a nested `value_type` type (`Ch`) and with a nested `traits_type` type.
64+
`str.data()` must return `Ch const*`. `str.data() + str.size()` must be of type `Ch const*`.
65+
`Ch` must be a character type (one of `char`, `wchar_t`, `char8_t`, `char16_t`, `char32_t`).
6366

6467
Effects: :: Parses the string `s` into a `uuid` and returns the result.
6568

0 commit comments

Comments
 (0)