| 1 | /*! |
|---|
| 2 | @file |
|---|
| 3 | Documents the `BOOST_HANA_DEFINE_STRUCT` macro. |
|---|
| 4 | |
|---|
| 5 | Copyright Louis Dionne 2013-2022 |
|---|
| 6 | Distributed under the Boost Software License, Version 1.0. |
|---|
| 7 | (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt) |
|---|
| 8 | */ |
|---|
| 9 | |
|---|
| 10 | #ifndef BOOST_HANA_FWD_DEFINE_STRUCT_HPP |
|---|
| 11 | #define BOOST_HANA_FWD_DEFINE_STRUCT_HPP |
|---|
| 12 | |
|---|
| 13 | #include <boost/hana/config.hpp> |
|---|
| 14 | |
|---|
| 15 | |
|---|
| 16 | namespace boost { namespace hana { |
|---|
| 17 | // Note: |
|---|
| 18 | // The weird definition as a variable seems to exploit a glitch in Doxygen |
|---|
| 19 | // which makes the macro appear in the related objects of Struct (as we |
|---|
| 20 | // want it to). |
|---|
| 21 | |
|---|
| 22 | //! Defines members of a structure, while at the same time |
|---|
| 23 | //! modeling `Struct`. |
|---|
| 24 | //! @ingroup group-Struct |
|---|
| 25 | //! |
|---|
| 26 | //! Using this macro in the body of a user-defined type will define the |
|---|
| 27 | //! given members inside that type, and will also provide a model of the |
|---|
| 28 | //! `Struct` concept for that user-defined type. This macro is often the |
|---|
| 29 | //! easiest way to define a model of the `Struct` concept. |
|---|
| 30 | //! |
|---|
| 31 | //! @note |
|---|
| 32 | //! This macro only works if the tag of the user-defined type `T` is `T` |
|---|
| 33 | //! itself. This is the case unless you specifically asked for something |
|---|
| 34 | //! different; see `tag_of`'s documentation. |
|---|
| 35 | //! |
|---|
| 36 | //! |
|---|
| 37 | //! Example |
|---|
| 38 | //! ------- |
|---|
| 39 | //! @include example/define_struct.cpp |
|---|
| 40 | #ifdef BOOST_HANA_DOXYGEN_INVOKED |
|---|
| 41 | auto BOOST_HANA_DEFINE_STRUCT(...) = ; |
|---|
| 42 | #define BOOST_HANA_DEFINE_STRUCT(Name, ...) see documentation |
|---|
| 43 | #else |
|---|
| 44 | // defined in <boost/hana/define_struct.hpp> |
|---|
| 45 | #endif |
|---|
| 46 | }} // end namespace boost::hana |
|---|
| 47 | |
|---|
| 48 | #endif // !BOOST_HANA_FWD_DEFINE_STRUCT_HPP |
|---|
| 49 | |
|---|
