Dominik Meyer cc002ebfbb Squashed 'libs/json/' content from commit f42a74b8

git-subtree-dir: libs/json
git-subtree-split: f42a74b8f53cc308647123d49d33d1c8122e3f42

2021-08-22 01:28:31 +02:00

basic_json::meta

static basic_json meta();

This function returns a JSON object with information about the library, including the version number and information on the platform and compiler.

Return value

JSON object holding version information

key	description
`compiler`	Information on the used compiler. It is an object with the following keys: `c++` (the used C++ standard), `family` (the compiler family; possible values are `clang`, `icc`, `gcc`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version).
`copyright`	The copyright line for the library as string.
`name`	The name of the library as string.
`platform`	The used platform as string. Possible values are `win32`, `linux`, `apple`, `unix`, and `unknown`.
`url`	The URL of the project as string.
`version`	The version of the library. It is an object with the following keys: `major`, `minor`, and `patch` as defined by Semantic Versioning, and `string` (the version string).

Strong guarantee: if an exception is thrown, there are no changes to any JSON value.

Constant.

The following code shows an example output of the meta() function.

--8<-- "examples/meta.cpp"

Output:

--8<-- "examples/meta.output"