generic-library/valijson
1
0
Fork 0
mirror of https://github.com/tristanpenman/valijson.git synced 2025-01-19 08:46:42 +01:00
Code Issues Projects Releases Wiki Activity

Add file-level documentation to std_string_adapter.hpp

Browse Source
This commit is contained in:
Tristan Penman 2019-10-10 13:32:16 +11:00
parent 6287656e2b
commit 42cdb3f5b3
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/valijson/adapters/std_string_adapter.hpp
View File

@ -1,3 +1,17 @@
/**
* @file
*
* @brief Adapter implementation that wraps a single std::string value
*
* This allows property names to be validated against a schema as though they are a generic JSON
* value, while allowing the rest of Valijson's API to expose property names as plain std::string
* values.
*
* This was added while implementing draft 7 support. This included support for a constraint
* called propertyNames, which can be used to ensure that the property names in an object
* validate against a subschema.
*/
#pragma once
#include <string>