1
0
mirror of https://github.com/nlohmann/json.git synced 2025-07-29 23:01:16 +03:00

📝 add more API documentation

This commit is contained in:
Niels Lohmann
2020-08-12 13:41:59 +02:00
parent b888afe5f4
commit fe89049aee
78 changed files with 5092 additions and 177 deletions

View File

@ -0,0 +1,39 @@
# basic_json::is_boolean
```cpp
constexpr bool is_boolean() const noexcept;
```
This function returns `#!cpp true` if and only if the JSON value is `#!json true` or `#!json false`.
## Return value
`#!cpp true` if type is boolean, `#!cpp false` otherwise.
## Exception safety
No-throw guarantee: this member function never throws exceptions.
## Complexity
Constant.
## Example
??? example
The following code exemplifies `is_boolean()` for all JSON types.
```cpp
--8<-- "examples/is_boolean.cpp"
```
Output:
```json
--8<-- "examples/is_boolean.output"
```
## Version history
- Added in version 1.0.0.