blob: 831f6872a4e973925212e0c246096c328948b8d1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
/*!
@file
Documents the `BOOST_HANA_DEFINE_STRUCT` macro.
@copyright Louis Dionne 2013-2017
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_DEFINE_STRUCT_HPP
#define BOOST_HANA_FWD_DEFINE_STRUCT_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 members of a structure, while at the same time
//! modeling `Struct`.
//! @ingroup group-Struct
//!
//! Using this macro in the body of a user-defined type will define the
//! given members inside that type, and will also provide a model of the
//! `Struct` concept for that user-defined type. This macro is often the
//! easiest way to define a model of the `Struct` concept.
//!
//! @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/define_struct.cpp
#ifdef BOOST_HANA_DOXYGEN_INVOKED
auto BOOST_HANA_DEFINE_STRUCT(...) = ;
#define BOOST_HANA_DEFINE_STRUCT(Name, ...) see documentation
#else
// defined in <boost/hana/define_struct.hpp>
#endif
BOOST_HANA_NAMESPACE_END
#endif // !BOOST_HANA_FWD_DEFINE_STRUCT_HPP
|
