From 42cef49a7f88c157de8d6b432f03ced80ffbb211 Mon Sep 17 00:00:00 2001 From: Michele Caini Date: Mon, 13 May 2024 11:55:30 +0200 Subject: [PATCH] doc: general update --- README.md | 24 +++--------------------- docs/md/config.md | 6 ------ docs/md/container.md | 6 ------ docs/md/core.md | 6 ------ docs/md/entity.md | 6 ------ docs/md/faq.md | 36 ++---------------------------------- docs/md/graph.md | 6 ------ docs/md/lib.md | 6 ------ docs/md/links.md | 6 ------ docs/md/locator.md | 6 ------ docs/md/meta.md | 6 ------ docs/md/poly.md | 6 ------ docs/md/process.md | 6 ------ docs/md/reference.md | 6 ------ docs/md/resource.md | 10 ++-------- docs/md/signal.md | 6 ------ docs/md/unreal.md | 6 ------ 17 files changed, 7 insertions(+), 147 deletions(-) diff --git a/README.md b/README.md index eb17173de..eb83fa48a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,5 @@ ![EnTT: Gaming meets modern C++](https://user-images.githubusercontent.com/1812216/103550016-90752280-4ea8-11eb-8667-12ed2219e137.png) - [![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) [![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 and the amazing [**Ragdoll**](https://ragdolldynamics.com/).
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) * [Contributors](#contributors) * [License](#license) - # Introduction @@ -354,16 +348,10 @@ To navigate it with your favorite browser: $ cd build $ your_favorite_browser docs/html/index.html - The same version is also available [online](https://skypjack.github.io/entt/) for the latest release, that is the last stable tag.
Moreover, there exists a [wiki](https://github.com/skypjack/entt/wiki) dedicated to the project where users can find all related documentation pages. - # Tests @@ -380,9 +368,6 @@ To build the most basic set of tests: Note that benchmarks are not part of this set. - # EnTT in Action `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. If you decide to participate, please see the guidelines for -[contributing](CONTRIBUTING.md) before to create issues or pull -requests.
+[contributing](https://github.com/skypjack/entt/blob/master/CONTRIBUTING.md) +before to create issues or pull requests.
Take also a look at the [contributors list](https://github.com/skypjack/entt/blob/master/AUTHORS) to know who has participated so far. - # License diff --git a/docs/md/config.md b/docs/md/config.md index b9d6132ee..1679b4f95 100644 --- a/docs/md/config.md +++ b/docs/md/config.md @@ -1,8 +1,5 @@ # Crash Course: configuration - # Table of Contents * [Introduction](#introduction) @@ -17,9 +14,6 @@ * [ENTT_DISABLE_ASSERT](#entt_disable_assert) * [ENTT_NO_ETO](#entt_no_eto) * [ENTT_STANDARD_CPP](#entt_standard_cpp) - # Introduction diff --git a/docs/md/container.md b/docs/md/container.md index 18bfc6849..cf43de4ce 100644 --- a/docs/md/container.md +++ b/docs/md/container.md @@ -1,17 +1,11 @@ # Crash Course: containers - # Table of Contents * [Introduction](#introduction) * [Containers](#containers) * [Dense map](#dense-map) * [Dense set](#dense-set) - # Introduction diff --git a/docs/md/core.md b/docs/md/core.md index b32d8bb5c..deb83fa9a 100644 --- a/docs/md/core.md +++ b/docs/md/core.md @@ -1,8 +1,5 @@ # Crash Course: core functionalities - # Table of Contents * [Introduction](#introduction) @@ -39,9 +36,6 @@ * [Compile-time generator](#compile-time-generator) * [Runtime generator](#runtime-generator) * [Utilities](#utilities) - # Introduction diff --git a/docs/md/entity.md b/docs/md/entity.md index 1211c12be..919e88081 100644 --- a/docs/md/entity.md +++ b/docs/md/entity.md @@ -1,8 +1,5 @@ # Crash Course: entity-component system - # Table of Contents * [Introduction](#introduction) @@ -65,9 +62,6 @@ * [Iterators](#iterators) * [Const registry](#const-registry) * [Beyond this document](#beyond-this-document) - # Introduction diff --git a/docs/md/faq.md b/docs/md/faq.md index a3bb60aad..eb45d1980 100644 --- a/docs/md/faq.md +++ b/docs/md/faq.md @@ -1,8 +1,5 @@ # Frequently Asked Questions - # Table of Contents * [Introduction](#introduction) @@ -10,14 +7,11 @@ * [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) * [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) * [Which functions trigger which signals](#which-functions-trigger-which-signals) * [Duplicate storage for the same component](#duplicate-storage-for-the-same-component) - # Introduction @@ -105,32 +99,6 @@ enum class entity: std::uint32_t {}; 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.
-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 On Windows, a header file defines two macros `min` and `max` which may result in diff --git a/docs/md/graph.md b/docs/md/graph.md index d71529996..407ac1adc 100644 --- a/docs/md/graph.md +++ b/docs/md/graph.md @@ -1,8 +1,5 @@ # Crash Course: graph - # Table of Contents * [Introduction](#introduction) @@ -14,9 +11,6 @@ * [Fake resources and order of execution](#fake-resources-and-order-of-execution) * [Sync points](#sync-points) * [Execution graph](#execution-graph) - # Introduction diff --git a/docs/md/lib.md b/docs/md/lib.md index ac1ab6cbc..6be3881d0 100644 --- a/docs/md/lib.md +++ b/docs/md/lib.md @@ -1,17 +1,11 @@ # Push EnTT across boundaries - # Table of Contents * [Working across boundaries](#working-across-boundaries) * [Smooth until proven otherwise](#smooth-until-proven-otherwise) * [Meta context](#meta-context) * [Memory management](#memory-management) - # Working across boundaries diff --git a/docs/md/links.md b/docs/md/links.md index ce6327506..6b788aca8 100644 --- a/docs/md/links.md +++ b/docs/md/links.md @@ -1,8 +1,5 @@ # EnTT in Action - # Table of Contents * [Introduction](#introduction) @@ -11,9 +8,6 @@ * [Engines and the like](#engines-and-the-like) * [Articles, videos and blog posts](#articles-videos-and-blog-posts) * [Any Other Business](#any-other-business) - # Introduction diff --git a/docs/md/locator.md b/docs/md/locator.md index eb8d1bb8b..6676c18be 100644 --- a/docs/md/locator.md +++ b/docs/md/locator.md @@ -1,16 +1,10 @@ # Crash Course: service locator - # Table of Contents * [Introduction](#introduction) * [Service locator](#service-locator) * [Opaque handles](#opaque-handles) - # Introduction diff --git a/docs/md/meta.md b/docs/md/meta.md index f2d27b347..46b187107 100644 --- a/docs/md/meta.md +++ b/docs/md/meta.md @@ -1,8 +1,5 @@ # Crash Course: runtime reflection system - # Table of Contents * [Introduction](#introduction) @@ -21,9 +18,6 @@ * [Properties and meta objects](#properties-and-meta-objects) * [Unregister types](#unregister-types) * [Meta context](#meta-context) - # Introduction diff --git a/docs/md/poly.md b/docs/md/poly.md index 1c37be2cc..1f790150a 100644 --- a/docs/md/poly.md +++ b/docs/md/poly.md @@ -1,8 +1,5 @@ # Crash Course: poly - # Table of Contents * [Introduction](#introduction) @@ -14,9 +11,6 @@ * [Inheritance](#inheritance) * [Static polymorphism in the wild](#static-polymorphism-in-the-wild) * [Storage size and alignment requirement](#storage-size-and-alignment-requirement) - # Introduction diff --git a/docs/md/process.md b/docs/md/process.md index 56cde90bd..bf931a423 100644 --- a/docs/md/process.md +++ b/docs/md/process.md @@ -1,17 +1,11 @@ # Crash Course: cooperative scheduler - # Table of Contents * [Introduction](#introduction) * [The process](#the-process) * [Adaptor](#adaptor) * [The scheduler](#the-scheduler) - # Introduction diff --git a/docs/md/reference.md b/docs/md/reference.md index 74e6e8187..bb10593b7 100644 --- a/docs/md/reference.md +++ b/docs/md/reference.md @@ -1,15 +1,9 @@ # Similar projects - # Table of Contents * [Introduction](#introduction) * [Similar projects](#similar-projects) - # Introduction diff --git a/docs/md/resource.md b/docs/md/resource.md index 37d4fa9c8..23998eabc 100644 --- a/docs/md/resource.md +++ b/docs/md/resource.md @@ -1,18 +1,12 @@ # Crash Course: resource management - # Table of Contents * [Introduction](#introduction) * [The resource, the loader and the cache](#the-resource-the-loader-and-the-cache) * [Resource handle](#resource-handle) - * [Loaders](#loader) - * [The cache class](#the-cache) - + * [Loaders](#loaders) + * [The cache class](#the-cache-class) # Introduction diff --git a/docs/md/signal.md b/docs/md/signal.md index b879697a3..188ee5386 100644 --- a/docs/md/signal.md +++ b/docs/md/signal.md @@ -1,8 +1,5 @@ # Crash Course: events, signals and everything in between - # Table of Contents * [Introduction](#introduction) @@ -14,9 +11,6 @@ * [Event dispatcher](#event-dispatcher) * [Named queues](#named-queues) * [Event emitter](#event-emitter) - # Introduction diff --git a/docs/md/unreal.md b/docs/md/unreal.md index eba7fde0d..9044ac711 100644 --- a/docs/md/unreal.md +++ b/docs/md/unreal.md @@ -1,16 +1,10 @@ # EnTT and Unreal Engine - # Table of Contents * [Enable Cpp17](#enable-cpp17) * [EnTT as a third party module](#entt-as-a-third-party-module) * [Include EnTT](#include-entt) - ## Enable Cpp17