Browse Source

doc: general update

Michele Caini 1 năm trước cách đây
mục cha
commit
42cef49a7f

+ 3 - 21
README.md

@@ -1,8 +1,5 @@
 ![EnTT: Gaming meets modern C++](https://user-images.githubusercontent.com/1812216/103550016-90752280-4ea8-11eb-8667-12ed2219e137.png)
 ![EnTT: Gaming meets modern C++](https://user-images.githubusercontent.com/1812216/103550016-90752280-4ea8-11eb-8667-12ed2219e137.png)
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 [![Build Status](https://github.com/skypjack/entt/workflows/build/badge.svg)](https://github.com/skypjack/entt/actions)
 [![Build Status](https://github.com/skypjack/entt/workflows/build/badge.svg)](https://github.com/skypjack/entt/actions)
 [![Coverage](https://codecov.io/gh/skypjack/entt/branch/master/graph/badge.svg)](https://codecov.io/gh/skypjack/entt)
 [![Coverage](https://codecov.io/gh/skypjack/entt/branch/master/graph/badge.svg)](https://codecov.io/gh/skypjack/entt)
 [![Try online](https://img.shields.io/badge/try-online-brightgreen)](https://godbolt.org/z/zxW73f)
 [![Try online](https://img.shields.io/badge/try-online-brightgreen)](https://godbolt.org/z/zxW73f)
@@ -24,7 +21,7 @@ in [**Minecraft**](https://minecraft.net/en-us/attribution/) by Mojang, the
 [**ArcGIS Runtime SDKs**](https://developers.arcgis.com/arcgis-runtime/) by Esri
 [**ArcGIS Runtime SDKs**](https://developers.arcgis.com/arcgis-runtime/) by Esri
 and the amazing [**Ragdoll**](https://ragdolldynamics.com/).<br/>
 and the amazing [**Ragdoll**](https://ragdolldynamics.com/).<br/>
 If you don't see your project in the list, please open an issue, submit a PR or
 If you don't see your project in the list, please open an issue, submit a PR or
-add the [#entt](https://github.com/topics/entt) tag to your _topics_! :+1:
+add the [\#entt](https://github.com/topics/entt) tag to your _topics_! :+1:
 
 
 ---
 ---
 
 
@@ -64,9 +61,6 @@ Many thanks to [these people](https://skypjack.github.io/sponsorship/) and
 * [EnTT in Action](#entt-in-action)
 * [EnTT in Action](#entt-in-action)
 * [Contributors](#contributors)
 * [Contributors](#contributors)
 * [License](#license)
 * [License](#license)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 
@@ -354,16 +348,10 @@ To navigate it with your favorite browser:
     $ cd build
     $ cd build
     $ your_favorite_browser docs/html/index.html
     $ your_favorite_browser docs/html/index.html
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 The same version is also available [online](https://skypjack.github.io/entt/)
 The same version is also available [online](https://skypjack.github.io/entt/)
 for the latest release, that is the last stable tag.<br/>
 for the latest release, that is the last stable tag.<br/>
 Moreover, there exists a [wiki](https://github.com/skypjack/entt/wiki) dedicated
 Moreover, there exists a [wiki](https://github.com/skypjack/entt/wiki) dedicated
 to the project where users can find all related documentation pages.
 to the project where users can find all related documentation pages.
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Tests
 # Tests
 
 
@@ -380,9 +368,6 @@ To build the most basic set of tests:
 
 
 Note that benchmarks are not part of this set.
 Note that benchmarks are not part of this set.
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # EnTT in Action
 # EnTT in Action
 
 
 `EnTT` is widely used in private and commercial applications. I cannot even
 `EnTT` is widely used in private and commercial applications. I cannot even
@@ -410,14 +395,11 @@ I can't promise that each and every contribution will be accepted, but I can
 assure that I'll do my best to take them all as soon as possible.
 assure that I'll do my best to take them all as soon as possible.
 
 
 If you decide to participate, please see the guidelines for
 If you decide to participate, please see the guidelines for
-[contributing](CONTRIBUTING.md) before to create issues or pull
-requests.<br/>
+[contributing](https://github.com/skypjack/entt/blob/master/CONTRIBUTING.md)
+before to create issues or pull requests.<br/>
 Take also a look at the
 Take also a look at the
 [contributors list](https://github.com/skypjack/entt/blob/master/AUTHORS) to
 [contributors list](https://github.com/skypjack/entt/blob/master/AUTHORS) to
 know who has participated so far.
 know who has participated so far.
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # License
 # License
 
 

+ 0 - 6
docs/md/config.md

@@ -1,8 +1,5 @@
 # Crash Course: configuration
 # Crash Course: configuration
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
@@ -17,9 +14,6 @@
     * [ENTT_DISABLE_ASSERT](#entt_disable_assert)
     * [ENTT_DISABLE_ASSERT](#entt_disable_assert)
   * [ENTT_NO_ETO](#entt_no_eto)
   * [ENTT_NO_ETO](#entt_no_eto)
   * [ENTT_STANDARD_CPP](#entt_standard_cpp)
   * [ENTT_STANDARD_CPP](#entt_standard_cpp)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/container.md

@@ -1,17 +1,11 @@
 # Crash Course: containers
 # Crash Course: containers
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
 * [Containers](#containers)
 * [Containers](#containers)
   * [Dense map](#dense-map)
   * [Dense map](#dense-map)
   * [Dense set](#dense-set)
   * [Dense set](#dense-set)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/core.md

@@ -1,8 +1,5 @@
 # Crash Course: core functionalities
 # Crash Course: core functionalities
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
@@ -39,9 +36,6 @@
   * [Compile-time generator](#compile-time-generator)
   * [Compile-time generator](#compile-time-generator)
   * [Runtime generator](#runtime-generator)
   * [Runtime generator](#runtime-generator)
 * [Utilities](#utilities)
 * [Utilities](#utilities)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/entity.md

@@ -1,8 +1,5 @@
 # Crash Course: entity-component system
 # Crash Course: entity-component system
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
@@ -65,9 +62,6 @@
   * [Iterators](#iterators)
   * [Iterators](#iterators)
   * [Const registry](#const-registry)
   * [Const registry](#const-registry)
 * [Beyond this document](#beyond-this-document)
 * [Beyond this document](#beyond-this-document)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 2 - 34
docs/md/faq.md

@@ -1,8 +1,5 @@
 # Frequently Asked Questions
 # Frequently Asked Questions
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
@@ -10,14 +7,11 @@
   * [Why is my debug build on Windows so slow?](#why-is-my-debug-build-on-windows-so-slow)
   * [Why is my debug build on Windows so slow?](#why-is-my-debug-build-on-windows-so-slow)
   * [How can I represent hierarchies with my components?](#how-can-i-represent-hierarchies-with-my-components)
   * [How can I represent hierarchies with my components?](#how-can-i-represent-hierarchies-with-my-components)
   * [Custom entity identifiers: yay or nay?](#custom-entity-identifiers-yay-or-nay)
   * [Custom entity identifiers: yay or nay?](#custom-entity-identifiers-yay-or-nay)
-  * [Warning C4307: integral constant overflow](#warning-C4307-integral-constant-overflow)
-  * [Warning C4003: the min, the max and the macro](#warning-C4003-the-min-the-max-and-the-macro)
+  * [Warning C4307: integral constant overflow](#warning-c4307-integral-constant-overflow)
+  * [Warning C4003: the min, the max and the macro](#warning-c4003-the-min-the-max-and-the-macro)
   * [The standard and the non-copyable types](#the-standard-and-the-non-copyable-types)
   * [The standard and the non-copyable types](#the-standard-and-the-non-copyable-types)
   * [Which functions trigger which signals](#which-functions-trigger-which-signals)
   * [Which functions trigger which signals](#which-functions-trigger-which-signals)
   * [Duplicate storage for the same component](#duplicate-storage-for-the-same-component)
   * [Duplicate storage for the same component](#duplicate-storage-for-the-same-component)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 
@@ -105,32 +99,6 @@ enum class entity: std::uint32_t {};
 
 
 There is no limit to the number of identifiers that can be defined.
 There is no limit to the number of identifiers that can be defined.
 
 
-## Warning C4307: integral constant overflow
-
-According to [this](https://github.com/skypjack/entt/issues/121) issue, using a
-hashed string under VS (toolset v141) could generate a warning.<br/>
-First of all, I want to reassure you: it's expected and harmless. However, it
-can be annoying.
-
-To suppress it and if you don't want to suppress all the other warnings as well,
-here is a workaround in the form of a macro:
-
-```cpp
-#if defined(_MSC_VER)
-#define HS(str) __pragma(warning(suppress:4307)) entt::hashed_string{str}
-#else
-#define HS(str) entt::hashed_string{str}
-#endif
-```
-
-With an example of use included:
-
-```cpp
-constexpr auto identifier = HS("my/resource/identifier");
-```
-
-Thanks to [huwpascoe](https://github.com/huwpascoe) for the courtesy.
-
 ## Warning C4003: the min, the max and the macro
 ## Warning C4003: the min, the max and the macro
 
 
 On Windows, a header file defines two macros `min` and `max` which may result in
 On Windows, a header file defines two macros `min` and `max` which may result in

+ 0 - 6
docs/md/graph.md

@@ -1,8 +1,5 @@
 # Crash Course: graph
 # Crash Course: graph
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
@@ -14,9 +11,6 @@
   * [Fake resources and order of execution](#fake-resources-and-order-of-execution)
   * [Fake resources and order of execution](#fake-resources-and-order-of-execution)
   * [Sync points](#sync-points)
   * [Sync points](#sync-points)
   * [Execution graph](#execution-graph)
   * [Execution graph](#execution-graph)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/lib.md

@@ -1,17 +1,11 @@
 # Push EnTT across boundaries
 # Push EnTT across boundaries
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Working across boundaries](#working-across-boundaries)
 * [Working across boundaries](#working-across-boundaries)
   * [Smooth until proven otherwise](#smooth-until-proven-otherwise)
   * [Smooth until proven otherwise](#smooth-until-proven-otherwise)
   * [Meta context](#meta-context)
   * [Meta context](#meta-context)
   * [Memory management](#memory-management)
   * [Memory management](#memory-management)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Working across boundaries
 # Working across boundaries
 
 

+ 0 - 6
docs/md/links.md

@@ -1,8 +1,5 @@
 # EnTT in Action
 # EnTT in Action
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
@@ -11,9 +8,6 @@
   * [Engines and the like](#engines-and-the-like)
   * [Engines and the like](#engines-and-the-like)
   * [Articles, videos and blog posts](#articles-videos-and-blog-posts)
   * [Articles, videos and blog posts](#articles-videos-and-blog-posts)
   * [Any Other Business](#any-other-business)
   * [Any Other Business](#any-other-business)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/locator.md

@@ -1,16 +1,10 @@
 # Crash Course: service locator
 # Crash Course: service locator
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
 * [Service locator](#service-locator)
 * [Service locator](#service-locator)
   * [Opaque handles](#opaque-handles)
   * [Opaque handles](#opaque-handles)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/meta.md

@@ -1,8 +1,5 @@
 # Crash Course: runtime reflection system
 # Crash Course: runtime reflection system
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
@@ -21,9 +18,6 @@
   * [Properties and meta objects](#properties-and-meta-objects)
   * [Properties and meta objects](#properties-and-meta-objects)
   * [Unregister types](#unregister-types)
   * [Unregister types](#unregister-types)
   * [Meta context](#meta-context)
   * [Meta context](#meta-context)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/poly.md

@@ -1,8 +1,5 @@
 # Crash Course: poly
 # Crash Course: poly
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
@@ -14,9 +11,6 @@
 * [Inheritance](#inheritance)
 * [Inheritance](#inheritance)
 * [Static polymorphism in the wild](#static-polymorphism-in-the-wild)
 * [Static polymorphism in the wild](#static-polymorphism-in-the-wild)
 * [Storage size and alignment requirement](#storage-size-and-alignment-requirement)
 * [Storage size and alignment requirement](#storage-size-and-alignment-requirement)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/process.md

@@ -1,17 +1,11 @@
 # Crash Course: cooperative scheduler
 # Crash Course: cooperative scheduler
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
 * [The process](#the-process)
 * [The process](#the-process)
   * [Adaptor](#adaptor)
   * [Adaptor](#adaptor)
 * [The scheduler](#the-scheduler)
 * [The scheduler](#the-scheduler)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/reference.md

@@ -1,15 +1,9 @@
 # Similar projects
 # Similar projects
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
 * [Similar projects](#similar-projects)
 * [Similar projects](#similar-projects)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 2 - 8
docs/md/resource.md

@@ -1,18 +1,12 @@
 # Crash Course: resource management
 # Crash Course: resource management
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
 * [The resource, the loader and the cache](#the-resource-the-loader-and-the-cache)
 * [The resource, the loader and the cache](#the-resource-the-loader-and-the-cache)
   * [Resource handle](#resource-handle)
   * [Resource handle](#resource-handle)
-  * [Loaders](#loader)
-  * [The cache class](#the-cache)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
+  * [Loaders](#loaders)
+  * [The cache class](#the-cache-class)
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/signal.md

@@ -1,8 +1,5 @@
 # Crash Course: events, signals and everything in between
 # Crash Course: events, signals and everything in between
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Introduction](#introduction)
 * [Introduction](#introduction)
@@ -14,9 +11,6 @@
 * [Event dispatcher](#event-dispatcher)
 * [Event dispatcher](#event-dispatcher)
   * [Named queues](#named-queues)
   * [Named queues](#named-queues)
 * [Event emitter](#event-emitter)
 * [Event emitter](#event-emitter)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 # Introduction
 # Introduction
 
 

+ 0 - 6
docs/md/unreal.md

@@ -1,16 +1,10 @@
 # EnTT and Unreal Engine
 # EnTT and Unreal Engine
 
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Table of Contents
 # Table of Contents
 
 
 * [Enable Cpp17](#enable-cpp17)
 * [Enable Cpp17](#enable-cpp17)
 * [EnTT as a third party module](#entt-as-a-third-party-module)
 * [EnTT as a third party module](#entt-as-a-third-party-module)
 * [Include EnTT](#include-entt)
 * [Include EnTT](#include-entt)
-<!--
-@endcond TURN_OFF_DOXYGEN
--->
 
 
 ## Enable Cpp17
 ## Enable Cpp17