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

core: doc review

Browse Source
This commit is contained in:
Michele Caini
2023-12-12 14:14:20 +01:00
parent c0f1a691f9
commit a986f68e45
7 changed files with 16 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/entt/core/any.hpp
View File

@@ -13,11 +13,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
enum class any_operation : std::uint8_t {
@@ -31,11 +27,7 @@ enum class any_operation : std::uint8_t {
};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/*! @brief Possible modes of an any object. */
enum class any_policy : std::uint8_t {

12
src/entt/core/compressed_pair.hpp
View File

@@ -9,11 +9,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename Type, std::size_t, typename = void>
@@ -73,11 +69,7 @@ struct compressed_pair_element<Type, Tag, std::enable_if_t<is_ebco_eligible_v<Ty
};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief A compressed pair.

12
src/entt/core/hashed_string.hpp
View File

@@ -7,11 +7,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename>
@@ -43,11 +39,7 @@ struct basic_hashed_string {
};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Zero overhead unique identifier.

12
src/entt/core/memory.hpp
View File

@@ -165,11 +165,7 @@ ENTT_CONSTEXPR auto allocate_unique(Allocator &allocator, Args &&...args) {
return std::unique_ptr<Type, allocation_deleter<allocator_type>>{ptr, alloc};
}
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename Type>
@@ -225,11 +221,7 @@ struct uses_allocator_construction<std::pair<Type, Other>> {
};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Uses-allocator construction utility (waiting for C++20).

12
src/entt/core/tuple.hpp
View File

@@ -7,11 +7,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename>
@@ -21,11 +17,7 @@ template<typename... Args>
struct is_tuple_impl<std::tuple<Args...>>: std::true_type {};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Provides the member constant `value` to true if a given type is a

12
src/entt/core/type_info.hpp
View File

@@ -11,11 +11,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
struct ENTT_API type_index final {
@@ -65,11 +61,7 @@ template<typename Type>
}
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Type sequential identifier.

24
src/entt/core/type_traits.hpp
View File

@@ -675,11 +675,7 @@ inline constexpr bool is_complete_v = is_complete<Type>::value;
template<typename Type, typename = void>
struct is_iterator: std::false_type {};
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename, typename = void>
@@ -689,11 +685,7 @@ template<typename Type>
struct has_iterator_category<Type, std::void_t<typename std::iterator_traits<Type>::iterator_category>>: std::true_type {};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/*! @copydoc is_iterator */
template<typename Type>
@@ -742,11 +734,7 @@ struct is_transparent<Type, std::void_t<typename Type::is_transparent>>: std::tr
template<typename Type>
inline constexpr bool is_transparent_v = is_transparent<Type>::value;
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename, typename = void>
@@ -805,11 +793,7 @@ template<typename Type>
}
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Provides the member constant `value` to true if a given type is