doc: typos

This commit is contained in:
Michele Caini
2020-10-07 15:29:09 +02:00
parent fbb77092eb
commit 958b245c3d
5 changed files with 47 additions and 47 deletions

View File

@@ -70,15 +70,15 @@ struct ENTT_API type_seq final {
/**
* @brief Type hash.
* @tparam Type Type for which to generate a hash value.
*/
* @brief Type hash.
* @tparam Type Type for which to generate a hash value.
*/
template<typename Type, typename = void>
struct type_hash final {
/**
* @brief Returns the numeric representation of a given type.
* @return The numeric representation of the given type.
*/
* @brief Returns the numeric representation of a given type.
* @return The numeric representation of the given type.
*/
#if defined ENTT_PRETTY_FUNCTION_CONSTEXPR
[[nodiscard]] static constexpr id_type value() ENTT_NOEXCEPT {
constexpr auto value = hashed_string::value(ENTT_PRETTY_FUNCTION);
@@ -98,15 +98,15 @@ struct type_hash final {
/**
* @brief Type name.
* @tparam Type Type for which to generate a name.
*/
* @brief Type name.
* @tparam Type Type for which to generate a name.
*/
template<typename Type, typename = void>
struct type_name final {
/**
* @brief Returns the name of a given type.
* @return The name of the given type.
*/
* @brief Returns the name of a given type.
* @return The name of the given type.
*/
#if defined ENTT_PRETTY_FUNCTION_CONSTEXPR
[[nodiscard]] static constexpr std::string_view value() ENTT_NOEXCEPT {
constexpr auto value = internal::type_name<Type>();
@@ -164,9 +164,9 @@ public:
type_info & operator=(type_info &&) ENTT_NOEXCEPT = default;
/**
* @brief Checks if a type info object is properly initialized.
* @return True if the object is properly initialized, false otherwise.
*/
* @brief Checks if a type info object is properly initialized.
* @return True if the object is properly initialized, false otherwise.
*/
[[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
return !(seq_func == nullptr);
}
@@ -188,18 +188,18 @@ public:
}
/**
* @brief Type name.
* @return Type name.
*/
* @brief Type name.
* @return Type name.
*/
[[nodiscard]] std::string_view name() const ENTT_NOEXCEPT {
return name_func();
}
/**
* @brief Compares the contents of two type info objects.
* @param other Object with which to compare.
* @return False if the two contents differ, true otherwise.
*/
* @brief Compares the contents of two type info objects.
* @param other Object with which to compare.
* @return False if the two contents differ, true otherwise.
*/
[[nodiscard]] bool operator==(const type_info &other) const ENTT_NOEXCEPT {
return hash_func == other.hash_func;
}
@@ -212,11 +212,11 @@ private:
/**
* @brief Compares the contents of two type info objects.
* @param lhs A type info object.
* @param rhs A type info object.
* @return True if the two contents differ, false otherwise.
*/
* @brief Compares the contents of two type info objects.
* @param lhs A type info object.
* @param rhs A type info object.
* @return True if the two contents differ, false otherwise.
*/
[[nodiscard]] inline bool operator!=(const type_info &lhs, const type_info &rhs) ENTT_NOEXCEPT {
return !(lhs == rhs);
}

View File

@@ -29,9 +29,9 @@ struct size_of<Type, std::void_t<decltype(sizeof(Type))>>
/**
* @brief Helper variable template.
* @tparam Type The type of which to return the size.
*/
* @brief Helper variable template.
* @tparam Type The type of which to return the size.
*/
template<class Type>
inline constexpr auto size_of_v = size_of<Type>::value;
@@ -217,19 +217,19 @@ struct type_list_contains;
/**
* @copybrief type_list_contains
* @tparam Type Types provided by the type list.
* @tparam Other Type to look for.
*/
* @copybrief type_list_contains
* @tparam Type Types provided by the type list.
* @tparam Other Type to look for.
*/
template<typename... Type, typename Other>
struct type_list_contains<type_list<Type...>, Other>: std::disjunction<std::is_same<Type, Other>...> {};
/**
* @brief Helper variable template.
* @tparam List Type list.
* @tparam Type Type to look for.
*/
* @brief Helper variable template.
* @tparam List Type list.
* @tparam Type Type to look for.
*/
template<class List, typename Type>
inline constexpr auto type_list_contains_v = type_list_contains<List, Type>::value;

View File

@@ -102,9 +102,9 @@ resource<type_list<>, type_list<Req...>> to_resource();
/**
* Internal details not to be documented.
* @endcond
*/
* Internal details not to be documented.
* @endcond
*/
/**

View File

@@ -348,9 +348,9 @@ public:
}
/**
* @brief Estimates the number of entities iterated by the view.
* @return Estimated number of entities iterated by the view.
*/
* @brief Estimates the number of entities iterated by the view.
* @return Estimated number of entities iterated by the view.
*/
[[nodiscard]] size_type size_hint() const ENTT_NOEXCEPT {
return (std::min)({ std::get<pool_type<Component> *>(pools)->size()... });
}

View File

@@ -1045,9 +1045,9 @@ public:
}
/**
* @brief Returns the size of the underlying type if known.
* @return The size of the underlying type if known, 0 otherwise.
*/
* @brief Returns the size of the underlying type if known.
* @return The size of the underlying type if known, 0 otherwise.
*/
[[nodiscard]] size_type size_of() const ENTT_NOEXCEPT {
return node->size_of;
}