RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-10-18 10:32:48 +02:00
Code Issues Projects Releases Wiki Activity

[NFC][llvm][docs] YamlIO: StringRef validate -> std::string validate

Browse Source 
A change in the API happened as per http://reviews.llvm.org/D89463
(latest related commit b9e2b59680ad1bbfd2b9110b3ebf3d2b22cad51b)
but the RST documentation was not updated to match this at that time.
This commit is contained in:
Whisperity 2021-07-09 11:37:38 +02:00
parent 295ae7d240
commit cb3c17db3f
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/YamlIO.rst
View File

@ -555,7 +555,7 @@ you can specialize on the class pointer. Examples:
No Normalization No Normalization
---------------- ----------------
The mapping() method is responsible, if needed, for normalizing and The ``mapping()`` method is responsible, if needed, for normalizing and
denormalizing. In a simple case where the native data structure requires no denormalizing. In a simple case where the native data structure requires no
normalization, the mapping method just uses mapOptional() or mapRequired() to normalization, the mapping method just uses mapOptional() or mapRequired() to
bind the struct's fields to YAML key names. For example: bind the struct's fields to YAML key names. For example:
@ -739,15 +739,15 @@ what the tag should be. This will also add that tag when writing yaml.
Validation Validation
---------- ----------
Sometimes in a yaml map, each key/value pair is valid, but the combination is Sometimes in a YAML map, each key/value pair is valid, but the combination is
not. This is similar to something having no syntax errors, but still having not. This is similar to something having no syntax errors, but still having
semantic errors. To support semantic level checking, YAML I/O allows semantic errors. To support semantic level checking, YAML I/O allows
an optional ``validate()`` method in a MappingTraits template specialization. an optional ``validate()`` method in a MappingTraits template specialization.
When parsing yaml, the ``validate()`` method is call *after* all key/values in When parsing YAML, the ``validate()`` method is call *after* all key/values in
the map have been processed. Any error message returned by the ``validate()`` the map have been processed. Any error message returned by the ``validate()``
method during input will be printed just a like a syntax error would be printed. method during input will be printed just a like a syntax error would be printed.
When writing yaml, the ``validate()`` method is called *before* the yaml When writing YAML, the ``validate()`` method is called *before* the YAML
key/values are written. Any error during output will trigger an ``assert()`` key/values are written. Any error during output will trigger an ``assert()``
because it is a programming error to have invalid struct values. because it is a programming error to have invalid struct values.
@ -766,11 +766,11 @@ because it is a programming error to have invalid struct values.
static void mapping(IO &io, Stuff &stuff) { static void mapping(IO &io, Stuff &stuff) {
... ...
} }
static StringRef validate(IO &io, Stuff &stuff) { static std::string validate(IO &io, Stuff &stuff) {
// Look at all fields in 'stuff' and if there // Look at all fields in 'stuff' and if there
// are any bad values return a string describing // are any bad values return a string describing
// the error. Otherwise return an empty string. // the error. Otherwise return an empty string.
return StringRef(); return std::string{};
} }
}; };