Просмотр исходного кода

doxy: TURN_OFF_DOXYGEN -> ENTT_INTERNAL

skypjack 1 месяц назад
Родитель
Сommit
ee3738d5e7

+ 2 - 2
src/entt/container/dense_map.hpp

@@ -24,7 +24,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 static constexpr std::size_t dense_map_placeholder_position = (std::numeric_limits<std::size_t>::max)();
@@ -1027,7 +1027,7 @@ private:
 
 } // namespace entt
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace std {
 
 template<typename Key, typename Value, typename Allocator>

+ 1 - 1
src/entt/container/dense_set.hpp

@@ -22,7 +22,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 static constexpr std::size_t dense_set_placeholder_position = (std::numeric_limits<std::size_t>::max)();

+ 2 - 2
src/entt/container/table.hpp

@@ -12,7 +12,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename... It>
@@ -420,7 +420,7 @@ private:
 
 } // namespace entt
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace std {
 
 template<typename... Container, typename Allocator>

+ 1 - 1
src/entt/core/any.hpp

@@ -13,7 +13,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 enum class any_request : std::uint8_t {

+ 1 - 1
src/entt/core/compressed_pair.hpp

@@ -10,7 +10,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Type, std::size_t, typename = void>

+ 1 - 1
src/entt/core/hashed_string.hpp

@@ -7,7 +7,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename = id_type>

+ 1 - 1
src/entt/core/memory.hpp

@@ -112,7 +112,7 @@ constexpr auto allocate_unique(Allocator &allocator, Args &&...args) {
     return std::unique_ptr<Type, allocation_deleter<allocator_type>>{ptr, alloc};
 }
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Type>

+ 1 - 1
src/entt/core/type_info.hpp

@@ -11,7 +11,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 struct ENTT_API type_index final {

+ 4 - 4
src/entt/core/type_traits.hpp

@@ -18,7 +18,7 @@ namespace entt {
 template<std::size_t N>
 struct choice_t
     // unfortunately, doxygen cannot parse such a construct
-    : /*! @cond TURN_OFF_DOXYGEN */ choice_t<N - 1> /*! @endcond */
+    : /*! @cond ENTT_INTERNAL */ choice_t<N - 1> /*! @endcond */
 {};
 
 /*! @copybrief choice_t */
@@ -230,7 +230,7 @@ struct type_list_cat<type_list<Type...>> {
 template<typename... List>
 using type_list_cat_t = type_list_cat<List...>::type;
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename...>
@@ -656,7 +656,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 */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename, typename = void>
@@ -715,7 +715,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 */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename, typename = void>

+ 1 - 1
src/entt/entity/component.hpp

@@ -8,7 +8,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Type, typename = void>

+ 1 - 1
src/entt/entity/entity.hpp

@@ -12,7 +12,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename>

+ 1 - 1
src/entt/entity/fwd.hpp

@@ -10,7 +10,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename>

+ 1 - 1
src/entt/entity/group.hpp

@@ -19,7 +19,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename, typename, typename>

+ 1 - 1
src/entt/entity/handle.hpp

@@ -13,7 +13,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename It>

+ 1 - 1
src/entt/entity/mixin.hpp

@@ -13,7 +13,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename, typename, typename = void>

+ 1 - 1
src/entt/entity/organizer.hpp

@@ -15,7 +15,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename>

+ 1 - 1
src/entt/entity/registry.hpp

@@ -33,7 +33,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename It>

+ 1 - 1
src/entt/entity/runtime_view.hpp

@@ -11,7 +11,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Set>

+ 1 - 1
src/entt/entity/snapshot.hpp

@@ -17,7 +17,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Registry>

+ 1 - 1
src/entt/entity/sparse_set.hpp

@@ -19,7 +19,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Container>

+ 1 - 1
src/entt/entity/storage.hpp

@@ -23,7 +23,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Container, auto Page>

+ 3 - 3
src/entt/entity/view.hpp

@@ -15,7 +15,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename... Type>
@@ -234,7 +234,7 @@ class basic_common_view {
     }
 
 protected:
-    /*! @cond TURN_OFF_DOXYGEN */
+    /*! @cond ENTT_INTERNAL */
     basic_common_view() noexcept {
         for(size_type pos{}, last = filter.size(); pos < last; ++pos) {
             filter[pos] = placeholder;
@@ -677,7 +677,7 @@ class basic_storage_view {
     static_assert(std::is_same_v<std::remove_cvref_t<Type>, Type>, "Unexpected type");
 
 protected:
-    /*! @cond TURN_OFF_DOXYGEN */
+    /*! @cond ENTT_INTERNAL */
     basic_storage_view() noexcept = default;
 
     basic_storage_view(const Type *value) noexcept

+ 1 - 1
src/entt/graph/adjacency_matrix.hpp

@@ -13,7 +13,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename It>

+ 1 - 1
src/entt/meta/container.hpp

@@ -24,7 +24,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Type, typename = void>

+ 2 - 2
src/entt/meta/context.hpp

@@ -9,7 +9,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 struct meta_type_node;
@@ -38,7 +38,7 @@ class meta_ctx: private internal::meta_context {
     friend struct internal::meta_context;
 };
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 [[nodiscard]] inline internal::meta_context &internal::meta_context::from(meta_ctx &ctx) {
     return ctx;
 }

+ 1 - 1
src/entt/meta/factory.hpp

@@ -26,7 +26,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 class basic_meta_factory {

+ 2 - 2
src/entt/meta/meta.hpp

@@ -26,7 +26,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Type>
@@ -1597,7 +1597,7 @@ inline bool meta_any::assign(meta_any &&other) {
     return meta_type{*ctx, node_or_assert().type(internal::meta_context::from(*ctx))};
 }
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 class meta_sequence_container::meta_iterator final {
     using vtable_type = void(const void *, const std::ptrdiff_t, meta_any *);
 

+ 1 - 1
src/entt/meta/node.hpp

@@ -21,7 +21,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 enum class meta_traits : std::uint32_t {

+ 6 - 6
src/entt/meta/policy.hpp

@@ -5,7 +5,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 struct meta_policy {};
@@ -15,7 +15,7 @@ struct meta_policy {};
 
 /*! @brief Empty class type used to request the _as-is_ policy. */
 struct as_value_t final: private internal::meta_policy {
-    /*! @cond TURN_OFF_DOXYGEN */
+    /*! @cond ENTT_INTERNAL */
     template<typename>
     static constexpr bool value = true;
     /*! @endcond */
@@ -23,7 +23,7 @@ struct as_value_t final: private internal::meta_policy {
 
 /*! @brief Empty class type used to request the _as void_ policy. */
 struct as_void_t final: private internal::meta_policy {
-    /*! @cond TURN_OFF_DOXYGEN */
+    /*! @cond ENTT_INTERNAL */
     template<typename>
     static constexpr bool value = true;
     /*! @endcond */
@@ -31,7 +31,7 @@ struct as_void_t final: private internal::meta_policy {
 
 /*! @brief Empty class type used to request the _as ref_ policy. */
 struct as_ref_t final: private internal::meta_policy {
-    /*! @cond TURN_OFF_DOXYGEN */
+    /*! @cond ENTT_INTERNAL */
     template<typename Type>
     static constexpr bool value = std::is_reference_v<Type> && !std::is_const_v<std::remove_reference_t<Type>>;
     /*! @endcond */
@@ -39,7 +39,7 @@ struct as_ref_t final: private internal::meta_policy {
 
 /*! @brief Empty class type used to request the _as cref_ policy. */
 struct as_cref_t final: private internal::meta_policy {
-    /*! @cond TURN_OFF_DOXYGEN */
+    /*! @cond ENTT_INTERNAL */
     template<typename Type>
     static constexpr bool value = std::is_reference_v<Type>;
     /*! @endcond */
@@ -47,7 +47,7 @@ struct as_cref_t final: private internal::meta_policy {
 
 /*! @brief Empty class type used to request the _as auto_ policy. */
 struct as_is_t final: private internal::meta_policy {
-    /*! @cond TURN_OFF_DOXYGEN */
+    /*! @cond ENTT_INTERNAL */
     template<typename>
     static constexpr bool value = true;
     /*! @endcond */

+ 1 - 1
src/entt/meta/range.hpp

@@ -12,7 +12,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 struct meta_base_node;

+ 1 - 1
src/entt/meta/utility.hpp

@@ -190,7 +190,7 @@ template<typename Policy = as_value_t, typename Type>
     return meta_dispatch<Policy, Type>(locator<meta_ctx>::value_or(), std::forward<Type>(value));
 }
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Policy, typename Candidate, typename... Args>

+ 2 - 2
src/entt/process/process.hpp

@@ -11,7 +11,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename, typename, typename>
@@ -287,7 +287,7 @@ private:
     state current;
 };
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Delta, typename Func, typename Allocator>

+ 1 - 1
src/entt/resource/cache.hpp

@@ -20,7 +20,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Type, typename It>

+ 1 - 1
src/entt/signal/delegate.hpp

@@ -12,7 +12,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<typename Ret, typename... Args>

+ 1 - 1
src/entt/signal/dispatcher.hpp

@@ -17,7 +17,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 struct basic_dispatcher_handler {

+ 1 - 1
src/entt/stl/functional.hpp

@@ -3,7 +3,7 @@
 
 #include "../config/config.h"
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace entt::stl {
 
 #ifndef ENTT_FORCE_STL

+ 1 - 1
src/entt/stl/memory.hpp

@@ -1,7 +1,7 @@
 #ifndef ENTT_STL_MEMORY_HPP
 #define ENTT_STL_MEMORY_HPP
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 #include "../config/config.h"
 
 namespace entt::stl {

+ 1 - 1
src/entt/tools/davey.hpp

@@ -19,7 +19,7 @@
 
 namespace entt {
 
-/*! @cond TURN_OFF_DOXYGEN */
+/*! @cond ENTT_INTERNAL */
 namespace internal {
 
 template<entity_like Entity, typename OnEntity>