general/tomlplusplus
2
0
Fork 0
mirror of https://github.com/marzer/tomlplusplus.git synced 2026-02-22 16:02:12 +00:00
Code Issues Projects Releases Wiki Activity

documentation improvements

Browse Source
This commit is contained in:
Mark Gillard
2020-02-27 19:52:10 +02:00
parent 9ed295f21c
commit 36df648407
3 changed files with 9 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -1,15 +1,14 @@
# toml++ (tomlplusplus) · [![c++version](https://img.shields.io/badge/c%2B%2B-17%2C%2020-informational)][cpp_compilers] [![tomlversion](https://img.shields.io/badge/TOML-v0.5.0-informational)][v0.5.0] [![CircleCI](https://circleci.com/gh/marzer/tomlplusplus.svg?style=shield)](https://circleci.com/gh/marzer/tomlplusplus) [![GitHub](https://img.shields.io/github/license/marzer/tomlplusplus)](./LICENSE)
# toml++ (tomlplusplus) · [![c++version](https://img.shields.io/badge/c%2B%2B-17%2C%2020-informational)][cpp_compilers] [![tomlversion](https://img.shields.io/badge/TOML-v0.5.0-informational)][v0.5.0] [![CircleCI](https://circleci.com/gh/marzer/tomlplusplus.svg?style=shield)](https://circleci.com/gh/marzer/tomlplusplus) [![GitHub](https://img.shields.io/github/license/marzer/tomlplusplus)](./LICENSE) [![Mentioned in Awesome C++](https://awesome.re/mentioned-badge.svg)](https://github.com/fffaraz/awesome-cpp)
![banner](docs/tomlplusplus-banner-small.png)
- Header-only
- [TOML v0.5.0](https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.5.0.md), plus optional support for some [unreleased TOML language features]
- C++17 (plus some C++20 features where available, e.g. experimental support for char8_t strings)
- [TOML v0.5.0](https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.5.0.md), plus support for some
[unreleased TOML language features] (these are optional)
- Proper UTF-8 handling (incl. BOM)
- Works with or without exceptions
- Doesn't require RTTI
- First-class support for serializing to JSON
- Tested on Clang and GCC and MSVC (VS2019)
- Tested on Clang, GCC and MSVC (VS2019)
<br>
@@ -80,7 +79,7 @@ The API is the same regardless of how you consume the library.
### Configuration
A number of configurable options are exposed in the form of preprocessor `#defines`. Most likely you
won't need to mess with these at all, butif you do, set them before including toml++.
won't need to mess with these at all, but if you do, set them before including toml++.
| Option | Type | Default | Description |
|----------------------------|:--------------:|-----------------------------------|----------------------------------------------------------------------------------------------------------|

2
extern/Catch2 vendored

Submodule extern/Catch2 updated: bff44f8b01...87b5bf77bc

26
include/toml++/toml.h
View File

@@ -72,14 +72,14 @@
///////////////////////////////////////////////////////////////////////
///
/// \section mainpage-features Features
/// - [TOML v0.5.0](https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.5.0.md), plus support for some
/// unreleased TOML features (these are optional)
/// - [TOML v0.5.0](https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.5.0.md), plus optional support for some
/// unreleased TOML features
/// - C++17 (plus some C++20 features where available, e.g. experimental support for char8_t strings)
/// - Proper UTF-8 handling (incl. BOM)
/// - Works with or without exceptions
/// - Doesn't require RTTI
/// - First-class support for serializing to JSON
/// - Tested on Clang and GCC and MSVC (VS2019)
/// - Tested on Clang, GCC and MSVC (VS2019)
///
///////////////////////////////////////////////////////////////////////
///
@@ -89,30 +89,12 @@
/// There's some minor configuration you can do to customize some basic library functionality, but that's totally
/// optional. See the [README](https://github.com/marzer/tomlplusplus/blob/master/README.md) for more info.
///
/// \m_class{m-note m-default}
///
/// \parblock
/// <h3>A word on Linkers and the One Definition Rule</h3>
/// Header-only libraries are great for minimal setup but can cause ODR violations and complex linker errors
/// in situations where multiple modules include them separately, each with different versions, configuration options,
/// exception handling modes...
///
/// This library attempts to combat this problem by nesting everything inside an additional inline namespace
/// that changes according to the library's major version, the compiler's exception-handling mode, et cetera.
/// \endparblock
///
///////////////////////////////////////////////////////////////////////
///
/// \section mainpage-api-documentation API Documentation
/// You're looking at it! Browse the docs using the links at the top of the page.
/// You can search from anywhere by pressing the TAB key.
///
/// \m_class{m-note m-default}
///
/// This library is still pretty hot off the presses so there's going to be some omissions,
/// typos and general sparseness throughout the docs.
/// If you spot something or have a suggestion, please [let me know](https://github.com/marzer/tomlplusplus/issues)!
///
///////////////////////////////////////////////////////////////////////
///
/// \section mainpage-example Basic examples
@@ -431,4 +413,4 @@
///
/// If you're using the single-header version of the library you don't need to distribute these files;
/// their contents is included in the preamble at the top of the file.
///
///