Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

meta: doc review

Browse Source
This commit is contained in:
Michele Caini
2023-12-12 14:14:42 +01:00
parent dfd7cb90d0
commit 3d9651b783
8 changed files with 24 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/entt/meta/container.hpp
View File

@@ -19,11 +19,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename, typename = void>
@@ -54,11 +50,7 @@ template<typename Type>
inline constexpr bool reserve_aware_container_v = reserve_aware_container<Type>::value;
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief General purpose implementation of meta sequence container traits.

24
src/entt/meta/context.hpp
View File

@@ -9,11 +9,7 @@ namespace entt {
class meta_ctx;
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
struct meta_type_node;
@@ -26,11 +22,7 @@ struct meta_context {
};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/*! @brief Disambiguation tag for constructors and the like. */
class meta_ctx_arg_t final {};
@@ -44,11 +36,7 @@ class meta_ctx: private internal::meta_context {
friend struct internal::meta_context;
};
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
[[nodiscard]] inline internal::meta_context &internal::meta_context::from(meta_ctx &ctx) {
return ctx;
}
@@ -56,11 +44,7 @@ class meta_ctx: private internal::meta_context {
[[nodiscard]] inline const internal::meta_context &internal::meta_context::from(const meta_ctx &ctx) {
return ctx;
}
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
} // namespace entt

12
src/entt/meta/factory.hpp
View File

@@ -22,11 +22,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
[[nodiscard]] inline decltype(auto) owner(meta_ctx &ctx, const type_info &info) {
@@ -57,11 +53,7 @@ inline meta_func_node &meta_extend(internal::meta_type_node &parent, const id_ty
}
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Basic meta factory to be used for reflection purposes.

12
src/entt/meta/meta.hpp
View File

@@ -1626,11 +1626,7 @@ inline bool meta_any::assign(meta_any &&other) {
return index < arity() ? node->arg(*ctx, index) : meta_type{};
}
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
class meta_sequence_container::meta_iterator final {
using vtable_type = void(const void *, const std::ptrdiff_t, meta_any *);
@@ -1789,11 +1785,7 @@ private:
vtable_type *vtable{};
any handle{};
};
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Returns the meta value type of a container.

12
src/entt/meta/node.hpp
View File

@@ -22,11 +22,7 @@ class meta_any;
class meta_type;
struct meta_handle;
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
enum class meta_traits : std::uint32_t {
@@ -267,11 +263,7 @@ template<typename Type>
}
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
} // namespace entt

40
src/entt/meta/policy.hpp
View File

@@ -7,58 +7,34 @@ namespace entt {
/*! @brief Empty class type used to request the _as ref_ policy. */
struct as_ref_t final {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
template<typename Type>
static constexpr bool value = std::is_reference_v<Type> && !std::is_const_v<std::remove_reference_t<Type>>;
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
};
/*! @brief Empty class type used to request the _as cref_ policy. */
struct as_cref_t final {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
template<typename Type>
static constexpr bool value = std::is_reference_v<Type>;
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
};
/*! @brief Empty class type used to request the _as-is_ policy. */
struct as_is_t final {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
template<typename>
static constexpr bool value = true;
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
};
/*! @brief Empty class type used to request the _as void_ policy. */
struct as_void_t final {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
template<typename>
static constexpr bool value = true;
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
};
/**

12
src/entt/meta/range.hpp
View File

@@ -10,11 +10,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename Type, typename It>
@@ -132,11 +128,7 @@ template<typename... Args>
}
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Iterable range to use to iterate all types of meta objects.

12
src/entt/meta/utility.hpp
View File

@@ -313,11 +313,7 @@ template<typename Type, auto Data, typename Policy = as_is_t>
return meta_getter<Type, Data, Policy>(locator<meta_ctx>::value_or(), std::move(instance));
}
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename Policy, typename Candidate, typename... Args>
@@ -361,11 +357,7 @@ template<typename Type, typename... Args, std::size_t... Index>
}
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Tries to _invoke_ an object given a list of erased parameters.