zhangyiss/toml11
1
0
Fork 0
mirror of https://github.com/ToruNiina/toml11.git synced 2025-09-18 02:08:09 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: add value ctor with comments to README

Browse Source
This commit is contained in:
ToruNiina
2019-06-21 14:31:28 +09:00
parent e8d535e485
commit ab1ef63da6
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -869,9 +869,20 @@ v.comments().push_back(" add this comment.");
// i = 42 // i = 42
``` ```
Also, you can pass a `std::vector<std::string>` when constructing a
`toml::basic_value<toml::preserve_comments>`.
```cpp
std::vector<std::string> comments{"comment 1", "comment 2"};
const toml::basic_value<toml::preserve_comments> v1(42, std::move(comments));
const toml::basic_value<toml::preserve_comments> v2(42, {"comment 1", "comment 2"});
```
When `toml::discard_comments` is chosen, comments will not be contained in a value. When `toml::discard_comments` is chosen, comments will not be contained in a value.
`value::comments()` will always be kept empty. `value::comments()` will always be kept empty.
All the modification on comments would be ignored. All the modification on comments would be ignored.
All the element access in a `discard_comments` causes the same error as accessing
an element of an empty `std::vector`.
The comments will also be serialized. If comments exist, those comments will be The comments will also be serialized. If comments exist, those comments will be
added just before the values. added just before the values.