API-Docs. Better oatpp/core/Types.hpp

This commit is contained in:
lganzzzo 2020-05-24 11:07:56 +03:00
parent aa9d53ca5b
commit 585d437b3f
7 changed files with 44 additions and 14 deletions

View File

@ -30,7 +30,7 @@
namespace oatpp {
/**
* ObjectWrapper over the void*.
* ObjectWrapper over the `void*`.
*/
typedef oatpp::data::mapping::type::Void Void;
@ -106,20 +106,20 @@ namespace oatpp {
*/
typedef oatpp::data::mapping::type::DTO DTO;
/*
* Mapping-Enabled DTO Object.
/**
* Mapping-Enabled DTO Object. &id:oatpp::data::mapping::type::DTOWrapper;
*/
template <class T>
using Object = oatpp::data::mapping::type::DTOWrapper<T>;
/*
/**
* Mapping-Enabled Enum. &id:oatpp::data::mapping::type::Enum;
*/
template <class T>
using Enum = oatpp::data::mapping::type::Enum<T>;
/*
* Mapping-Enabled List. &id:oatpp::data::mapping::type::Vector;
/**
* Mapping-Enabled Vector. &id:oatpp::data::mapping::type::Vector;
*/
template <class T>
using Vector = oatpp::data::mapping::type::Vector<T>;
@ -129,7 +129,7 @@ namespace oatpp {
*/
typedef oatpp::data::mapping::type::AbstractVector AbstractVector;
/*
/**
* Mapping-Enabled List. &id:oatpp::data::mapping::type::List;
*/
template <class T>
@ -140,7 +140,7 @@ namespace oatpp {
*/
typedef oatpp::data::mapping::type::AbstractList AbstractList;
/*
/**
* Mapping-Enabled UnorderedSet. &id:oatpp::data::mapping::type::UnorderedSet;
*/
template <class T>
@ -151,22 +151,34 @@ namespace oatpp {
*/
typedef oatpp::data::mapping::type::AbstractUnorderedSet AbstractUnorderedSet;
/*
* Mapping-Enables PairList<String, Value>. &id:oatpp::data::mapping::type::PairList;
/**
* Mapping-Enabled PairList<Key, Value>. &id:oatpp::data::mapping::type::PairList;
*/
template <class Key, class Value>
using PairList = oatpp::data::mapping::type::PairList<Key, Value>;
/**
* Mapping-Enabled PairList<String, Value>. &id:oatpp::data::mapping::type::PairList;
*/
template <class Value>
using Fields = oatpp::data::mapping::type::PairList<String, Value>;
using Fields = oatpp::PairList<String, Value>;
/**
* Abstract Fields
*/
typedef data::mapping::type::PairListObjectWrapper<oatpp::String, oatpp::Void, data::mapping::type::__class::AbstractPairList> AbstractFields;
/*
* Mapping-Enables PairList<String, Value>. &id:oatpp::data::mapping::type::UnorderedFields;
/**
* Mapping-Enabled UnorderedMap<Key, Value>. &id:oatpp::data::mapping::type::UnorderedMap;.
*/
template <class Key, class Value>
using UnorderedMap = oatpp::data::mapping::type::UnorderedMap<Key, Value>;
/**
* Mapping-Enabled UnorderedMap<String, Value>. &id:oatpp::data::mapping::type::UnorderedMap;.
*/
template <class Value>
using UnorderedFields = oatpp::data::mapping::type::UnorderedMap<String, Value>;
using UnorderedFields = oatpp::UnorderedMap<String, Value>;
/**
* Abstract UnorderedFields

View File

@ -445,6 +445,9 @@ public:
};
/**
* Mapping-enabled Enum. See &l:EnumObjectWrapper;.
*/
template <class T>
using Enum = EnumObjectWrapper<T, EnumInterpreterAsString<T, false>>;

View File

@ -104,6 +104,9 @@ public:
};
/**
* Mapping-Enabled List. See - &l:ListObjectWrapper;.
*/
template<class T>
using List = ListObjectWrapper<T, __class::List<T>>;

View File

@ -132,6 +132,9 @@ public:
};
/**
* Mapping-Enables PairList<Key, Value>. See &l:PairListObjectWrapper;.
*/
template<class Key, class Value>
using PairList = PairListObjectWrapper<Key, Value, __class::PairList<Key, Value>>;

View File

@ -105,6 +105,9 @@ public:
};
/**
* Mapping-Enables UnorderedMap<Key, Value>. See &l:UnorderedMapObjectWrapper;.
*/
template<class Key, class Value>
using UnorderedMap = UnorderedMapObjectWrapper<Key, Value, __class::UnorderedMap<Key, Value>>;

View File

@ -106,6 +106,9 @@ public:
};
/**
* Mapping-Enabled UnorderedSet. See &l:UnorderedSetObjectWrapper;.
*/
template<class T>
using UnorderedSet = UnorderedSetObjectWrapper<T, __class::UnorderedSet<T>>;

View File

@ -102,6 +102,9 @@ public:
};
/**
* Mapping-enabled Vector. See &l:VectorObjectWrapper;.
*/
template<class T>
using Vector = VectorObjectWrapper<T, __class::Vector<T>>;