From d818bec6ac5ccb6f01f263b99842c15b1f9260a3 Mon Sep 17 00:00:00 2001 From: Niels Date: Sun, 21 Jun 2015 11:29:32 +0200 Subject: [PATCH] more documentation --- src/json.hpp | 12 ++++++++++++ src/json.hpp.re2c | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/src/json.hpp b/src/json.hpp index edc3ec3c..175965b7 100644 --- a/src/json.hpp +++ b/src/json.hpp @@ -84,6 +84,18 @@ struct has_mapped_type @tparam AllocatorType type of the allocator to use (@c std::allocator by default) +@requirement This class satisfies the Container requirements (see http://en.cppreference.com/w/cpp/concept/Container): +- @ref basic_json() +- @ref basic_json(const basic_json&) +- @ref reference& operator=(basic_json) +- @ref ~basic_json() +- @ref iterator begin(), @ref const_iterator begin(), @ref const_iterator cbegin() +- @ref iterator end(), @ref const_iterator end(), @ref const_iterator cend() +- @ref bool operator==(const_reference, const_reference), @ref bool operator!=(const_reference, const_reference) +- @ref void swap(reference other) +- @ref size_type size(), @ref size_type max_size() +- @ref bool empty() + @note ObjectType trick from http://stackoverflow.com/a/9860911 @see RFC 7159 diff --git a/src/json.hpp.re2c b/src/json.hpp.re2c index 2d97b133..7659abcb 100644 --- a/src/json.hpp.re2c +++ b/src/json.hpp.re2c @@ -84,6 +84,18 @@ struct has_mapped_type @tparam AllocatorType type of the allocator to use (@c std::allocator by default) +@requirement This class satisfies the Container requirements (see http://en.cppreference.com/w/cpp/concept/Container): +- @ref basic_json() +- @ref basic_json(const basic_json&) +- @ref reference& operator=(basic_json) +- @ref ~basic_json() +- @ref iterator begin(), @ref const_iterator begin(), @ref const_iterator cbegin() +- @ref iterator end(), @ref const_iterator end(), @ref const_iterator cend() +- @ref bool operator==(const_reference, const_reference), @ref bool operator!=(const_reference, const_reference) +- @ref void swap(reference other) +- @ref size_type size(), @ref size_type max_size() +- @ref bool empty() + @note ObjectType trick from http://stackoverflow.com/a/9860911 @see RFC 7159