Browse Source

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

Michele Caini 5 năm trước cách đây
mục cha
commit
5c3b956542

+ 1 - 1
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
  */
 
 

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

@@ -47,7 +47,7 @@ template<typename Type>
 
 /**
  * Internal details not to be documented.
- * @endcond TURN_OFF_DOXYGEN
+ * @endcond
  */
 
 

+ 11 - 11
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);\

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

@@ -156,7 +156,7 @@ template<typename Entity>
 
 /**
  * Internal details not to be documented.
- * @endcond TURN_OFF_DOXYGEN
+ * @endcond
  */
 
 

+ 1 - 1
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
  */
 
 

+ 1 - 1
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
  */
 
 

+ 1 - 1
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
  */
 
 

+ 1 - 1
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
  */