49 lines
1.6 KiB
C++
49 lines
1.6 KiB
C++
/*!
|
|
@file
|
|
Documents the `BOOST_HANA_ADAPT_ADT` macro.
|
|
|
|
@copyright Louis Dionne 2013-2016
|
|
Distributed under the Boost Software License, Version 1.0.
|
|
(See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
|
|
*/
|
|
|
|
#ifndef BOOST_HANA_FWD_ADAPT_ADT_HPP
|
|
#define BOOST_HANA_FWD_ADAPT_ADT_HPP
|
|
|
|
#include <boost/hana/config.hpp>
|
|
|
|
|
|
BOOST_HANA_NAMESPACE_BEGIN
|
|
// Note:
|
|
// The weird definition as a variable seems to exploit a glitch in Doxygen
|
|
// which makes the macro appear in the related objects of Struct (as we
|
|
// want it to).
|
|
|
|
//! Defines a model of `Struct` with the given accessors.
|
|
//! @ingroup group-Struct
|
|
//!
|
|
//! Using this macro at _global scope_ will define a model of the `Struct`
|
|
//! concept for the given type. This can be used to easily adapt existing
|
|
//! user-defined types in a ad-hoc manner. Unlike `BOOST_HANA_ADAPT_STRUCT`,
|
|
//! this macro requires specifying the way to retrieve each member by
|
|
//! providing a function that does the extraction.
|
|
//!
|
|
//! @note
|
|
//! This macro only works if the tag of the user-defined type `T` is `T`
|
|
//! itself. This is the case unless you specifically asked for something
|
|
//! different; see `tag_of`'s documentation.
|
|
//!
|
|
//!
|
|
//! Example
|
|
//! -------
|
|
//! @include example/adapt_adt.cpp
|
|
#ifdef BOOST_HANA_DOXYGEN_INVOKED
|
|
auto BOOST_HANA_ADAPT_ADT(...) = ;
|
|
#define BOOST_HANA_ADAPT_ADT(Name, ...) see documentation
|
|
#else
|
|
// defined in <boost/hana/adapt_adt.hpp>
|
|
#endif
|
|
BOOST_HANA_NAMESPACE_END
|
|
|
|
#endif // !BOOST_HANA_FWD_ADAPT_ADT_HPP
|