doc: fixed some problems with doxygen (see skypjack#510)

lore14th · Jun 22, 2020 · 5c3b956 · 5c3b956
1 parent ade8533
commit 5c3b956
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 18 deletions.
diff --git a/src/entt/core/hashed_string.hpp b/src/entt/core/hashed_string.hpp
@@ -45,7 +45,7 @@ struct fnv1a_traits<std::uint64_t> {
 
 /**
  * Internal details not to be documented.
- * @endcond TURN_OFF_DOXYGEN
+ * @endcond
  */
 
 

diff --git a/src/entt/core/type_info.hpp b/src/entt/core/type_info.hpp
@@ -47,7 +47,7 @@ template<typename Type>
 
 /**
  * Internal details not to be documented.
- * @endcond TURN_OFF_DOXYGEN
+ * @endcond
  */
 
 

diff --git a/src/entt/core/type_traits.hpp b/src/entt/core/type_traits.hpp
@@ -55,7 +55,7 @@ struct choice_t
  // Unfortunately, doxygen cannot parse such a construct.
  /*! @cond TURN_OFF_DOXYGEN */
  : choice_t<N-1>
- /*! @endcond TURN_OFF_DOXYGEN */
+ /*! @endcond */
 {};
 
 
@@ -241,18 +241,18 @@ using member_class_t = typename member_class<Member>::type;
 
 
 #define ENTT_OPAQUE_TYPE(clazz, type)\
- /**\
- * @brief Defines an enum class to use for opaque identifiers and a\
- * dedicate `to_integer` function to convert the identifiers to their\
- * underlying type.\
- * @param clazz The name to use for the enum class.\
- * @param type The underlying type for the enum class.\
+ /*!\
+   @brief Defines an enum class to use for opaque identifiers and a\
+  dedicate `to_integral` function to convert the identifiers to their\
+   underlying type.\
+   @param clazz The name to use for the enum class.\
+   @param type The underlying type for the enum class.\
  */\
  enum class clazz: type {};\
- /**\
- * @brief Converts an opaque type value to its underlying type.\
- * @param id The value to convert.\
- * @return The integral representation of the given value.
+ /*!\
+   @brief Converts an opaque type value to its underlying type.\
+   @param id The value to convert.\
+   @return The integral representation of the given value.
  */\
  [[nodiscard]] constexpr auto to_integral(const clazz id) ENTT_NOEXCEPT {\
  return static_cast<std::underlying_type_t<clazz>>(id);\

diff --git a/src/entt/entity/entity.hpp b/src/entt/entity/entity.hpp
@@ -156,7 +156,7 @@ template<typename Entity>
 
 /**
  * Internal details not to be documented.
- * @endcond TURN_OFF_DOXYGEN
+ * @endcond
  */
 
 

diff --git a/src/entt/meta/ctx.hpp b/src/entt/meta/ctx.hpp
@@ -53,7 +53,7 @@ struct ENTT_API meta_context {
 
 /**
  * Internal details not to be documented.
- * @endcond TURN_OFF_DOXYGEN
+ * @endcond
  */
 
 

diff --git a/src/entt/meta/factory.hpp b/src/entt/meta/factory.hpp
@@ -190,7 +190,7 @@ template<typename Type, auto Candidate, typename Policy, std::size_t... Indexes>
 
 /**
  * Internal details not to be documented.
- * @endcond TURN_OFF_DOXYGEN
+ * @endcond
  */
 
 

diff --git a/src/entt/meta/internal.hpp b/src/entt/meta/internal.hpp
@@ -445,7 +445,7 @@ struct meta_info: meta_node<std::remove_cv_t<std::remove_reference_t<Type>>...>
 
 /**
  * Internal details not to be documented.
- * @endcond TURN_OFF_DOXYGEN
+ * @endcond
  */
 
 

diff --git a/src/entt/signal/delegate.hpp b/src/entt/signal/delegate.hpp
@@ -57,7 +57,7 @@ template<typename... Class, typename Ret, typename... Args>
 
 /**
  * Internal details not to be documented.
- * @endcond TURN_OFF_DOXYGEN
+ * @endcond
  */