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

entity: doc review

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

12
src/entt/entity/component.hpp
View File

@@ -8,11 +8,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename Type, typename = void>
@@ -36,11 +32,7 @@ struct page_size<Type, std::void_t<decltype(Type::page_size)>>
: std::integral_constant<std::size_t, Type::page_size> {};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Common way to access various properties of components.

12
src/entt/entity/entity.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 {
// waiting for C++20 and std::popcount
@@ -60,11 +56,7 @@ struct entt_traits<std::uint64_t> {
};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Common basic entity traits implementation.

12
src/entt/entity/group.hpp
View File

@@ -16,11 +16,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename, typename, typename>
@@ -252,11 +248,7 @@ private:
};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Group.

12
src/entt/entity/handle.hpp
View File

@@ -12,11 +12,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename It>
@@ -87,11 +83,7 @@ template<typename ILhs, typename IRhs>
}
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Non-owning handle to an entity.

12
src/entt/entity/organizer.hpp
View File

@@ -15,11 +15,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename>
@@ -87,11 +83,7 @@ template<typename... Req, typename Ret, typename Class, typename... Args>
resource_traits<type_list<std::remove_reference_t<Args>...>, type_list<Req...>> constrained_function_to_resource_traits(Ret (Class::*)(Args...) const);
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Utility class for creating a static task graph.

12
src/entt/entity/registry.hpp
View File

@@ -30,11 +30,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename It>
@@ -226,11 +222,7 @@ private:
};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Fast and reliable entity-component system.

12
src/entt/entity/runtime_view.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 {
template<typename Set>
@@ -95,11 +91,7 @@ private:
};
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Generic runtime view.

12
src/entt/entity/snapshot.hpp
View File

@@ -16,11 +16,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename Registry>
@@ -35,11 +31,7 @@ void orphans(Registry &registry) {
}
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Utility class to create snapshots from a registry.

12
src/entt/entity/sparse_set.hpp
View File

@@ -17,11 +17,7 @@
namespace entt {
/**
* @cond TURN_OFF_DOXYGEN
* Internal details not to be documented.
*/
/*! @cond TURN_OFF_DOXYGEN */
namespace internal {
template<typename Container>
@@ -137,11 +133,7 @@ template<typename Container>
}
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Basic sparse set implementation.

12
src/entt/entity/storage.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 Container, std::size_t Size>
@@ -212,11 +208,7 @@ template<typename... Lhs, typename... Rhs>
}
} // namespace internal
/**
* Internal details not to be documented.
* @endcond
*/
/*! @endcond */
/**
* @brief Basic storage implementation.