Refactoring

.github/workflows/docs.yml

@@ -14,8 +14,8 @@ concurrency:
 
 jobs:
   Build:
-    #runs-on: 'ubuntu-latest'
-    runs-on: 'ubuntu-22.04'
+    runs-on: 'ubuntu-latest'
+    #runs-on: 'ubuntu-22.04'
 
     steps:
     - name: 'Checkout Repository'

Docs/Death.dox

@@ -34,6 +34,9 @@ namespace Death {
 	by checking the @cpp _CPPUNWIND @ce and @cpp __EXCEPTIONS @ce defines. If
 	@cpp DEATH_SUPPRESS_EXCEPTIONS @ce is defined, exception support is explicitly
 	disabled. In this case, @cpp throw @ce is usually replaced with asserts.
+
+	No need to @cpp #include @ce anything for this macro to be defined,
+	it's supplied via a compiler flag by CMake.
 */
 #define DEATH_SUPPRESS_EXCEPTIONS
 #undef DEATH_SUPPRESS_EXCEPTIONS

Docs/conf.py

@@ -1,5 +1,5 @@
 DOXYFILE = 'Doxyfile'
-FAVICON = 'favicon.ico'
+#FAVICON = 'favicon.ico'
 MAIN_PROJECT_URL = 'https://deat.tk/jazz2/'
 SHOW_UNDOCUMENTED = True
 VERSION_LABELS = True

Sources/Jazz2/Collisions/DynamicTree.h

@@ -50,25 +50,32 @@ namespace Jazz2::Collisions
 	*/
 	struct TreeNode
 	{
-		/// Enlarged AABB
+		/** @brief Enlarged AABB */
 		AABBf Aabb;
 
+		/** @brief Opaque pointer to user-supplied data */
 		void* UserData;
 
 		union
 		{
+			/** @brief Node ID of parent node */
 			std::int32_t Parent;
+			/** @brief Node ID of next node */
 			std::int32_t Next;
 		};
 
+		/** @brief Node ID of the first child */
 		std::int32_t Child1;
+		/** @brief Node ID of the second child */
 		std::int32_t Child2;
 
-		// leaf = 0, free node = -1
+		/** @brief Height (leaf = 0, free node = -1) */
 		std::int32_t Height;
 
+		/** @brief Whether node has been moved */
 		bool Moved;
 
+		/** @brief Returns whether the node is leaf */
 		bool IsLeaf() const
 		{
 			return (Child1 == NullNode);
@@ -118,7 +125,7 @@ namespace Jazz2::Collisions
 		 */
 		void* GetUserData(std::int32_t proxyId) const;
 
-		/** @brief Returns `true` if a proxy was moved */
+		/** @brief Returns `true` if a proxy has been moved */
 		bool WasMoved(std::int32_t proxyId) const;
 		/** @brief Clears moved status of a proxy */
 		void ClearMoved(std::int32_t proxyId);
@@ -130,15 +137,15 @@ namespace Jazz2::Collisions
 		template<typename T>
 		void Query(T* callback, const AABBf& aabb) const;
 
-		///* @brief Ray-cast against the proxies in the tree
-		// *
-		// * This relies on the callback to perform a exact ray-cast in the case were the proxy contains a shape.
-		// * The callback also performs the any collision filtering. This has performance
-		// * roughly equal to @f$ k * log(n) @f$, where k is the number of collisions and n is the
-		// * number of proxies in the tree.
-		// * @param input the ray-cast input data. The ray extends from p1 to p1 + maxFraction * (p2 - p1).
-		// * @param callback a callback class that is called for each proxy that is hit by the ray.
-		// */
+		// @brief Ray-cast against the proxies in the tree
+		//
+		// This relies on the callback to perform a exact ray-cast in the case were the proxy contains a shape.
+		// The callback also performs the any collision filtering. This has performance
+		// roughly equal to @f$ k * log(n) @f$, where k is the number of collisions and n is the
+		// number of proxies in the tree.
+		// @param input the ray-cast input data. The ray extends from p1 to p1 + maxFraction * (p2 - p1).
+		// @param callback a callback class that is called for each proxy that is hit by the ray.
+		//
 		//template <typename T>
 		//void RayCast(T* callback, const b2RayCastInput& input) const;
 
@@ -157,7 +164,7 @@ namespace Jazz2::Collisions
 		/** @brief Returns the ratio of the sum of the node areas to the root area */
 		float GetAreaRatio() const;
 
-		/** @brief Build an optimal tree, very expensive --- for testing only */
+		/** @brief Builds an optimal tree, very expensive --- for testing only */
 		void RebuildBottomUp();
 
 		/**

Sources/Jazz2/Collisions/DynamicTreeBroadPhase.h

@@ -28,7 +28,9 @@ namespace Jazz2::Collisions
 {
 	/** @brief Collided pair of objects found by collision detection */
 	struct CollisionPair {
+		/** @brief Proxy ID of the first node */
 		std::int32_t ProxyIdA;
+		/** @brief Proxy ID of the second node */
 		std::int32_t ProxyIdB;
 	};
 

Sources/Jazz2/Multiplayer/ServerDiscovery.cpp

@@ -108,7 +108,7 @@ namespace Jazz2::Multiplayer
 		}
 	}
 
-	bool ServerDiscovery::ProcessResponses(ENetSocket socket, ServerDesc& discoveredServer, std::int32_t timeoutMs)
+	bool ServerDiscovery::ProcessResponses(ENetSocket socket, ServerDescription& discoveredServer, std::int32_t timeoutMs)
 	{
 		ENetSocketSet set;
 		ENET_SOCKETSET_EMPTY(set);
@@ -200,7 +200,7 @@ namespace Jazz2::Multiplayer
 				TrySendRequest(socket, _this->_address);
 			}
 
-			ServerDesc discoveredServer;
+			ServerDescription discoveredServer;
 			if (ProcessResponses(socket, discoveredServer, 0)) {
 				observer->OnServerFound(std::move(discoveredServer));
 			} else {

Sources/Jazz2/Multiplayer/ServerDiscovery.h

@@ -20,6 +20,7 @@
 #undef far
 
 #include <Containers/SmallVector.h>
+#include <Containers/StaticArray.h>
 #include <Containers/String.h>
 #include <Containers/StringView.h>
 
@@ -29,7 +30,7 @@ using namespace nCine;
 namespace Jazz2::Multiplayer
 {
 	/** @brief Server description */
-	struct ServerDesc
+	struct ServerDescription
 	{
 #ifndef DOXYGEN_GENERATING_OUTPUT
 		/** @brief Server endpoint */
@@ -38,7 +39,7 @@ namespace Jazz2::Multiplayer
 		/** @brief Server endpoint in text format */
 		String EndpointString;
 		/** @brief Server unique identifier */
-		std::uint8_t UniqueIdentifier[16];
+		StaticArray<16, std::uint8_t> UniqueIdentifier;
 		/** @brief Server name */
 		String Name;
 		/** @brief Game mode and flags */
@@ -63,7 +64,7 @@ namespace Jazz2::Multiplayer
 	{
 	public:
 		/** @brief Called when a server is discovered */
-		virtual void OnServerFound(ServerDesc&& desc) = 0;
+		virtual void OnServerFound(ServerDescription&& desc) = 0;
 	};
 
 	/**
@@ -102,7 +103,7 @@ namespace Jazz2::Multiplayer
 		static ENetSocket TryCreateSocket(const char* multicastAddress, ENetAddress& parsedAddress);
 
 		static void TrySendRequest(ENetSocket socket, const ENetAddress& address);
-		static bool ProcessResponses(ENetSocket socket, ServerDesc& discoveredServer, std::int32_t timeoutMs = 0);
+		static bool ProcessResponses(ENetSocket socket, ServerDescription& discoveredServer, std::int32_t timeoutMs = 0);
 		static bool ProcessRequests(ENetSocket socket, std::int32_t timeoutMs = 0);
 
 		static void OnClientThread(void* param);

Sources/Jazz2/UI/Menu/ServerSelectSection.cpp

@@ -256,7 +256,7 @@ namespace Jazz2::UI::Menu
 		}
 	}
 
-	void ServerSelectSection::OnServerFound(Multiplayer::ServerDesc&& desc)
+	void ServerSelectSection::OnServerFound(Multiplayer::ServerDescription&& desc)
 	{
 		for (auto& item : _items) {
 			if (item.Desc.EndpointString == desc.EndpointString) {
@@ -293,7 +293,7 @@ namespace Jazz2::UI::Menu
 		}
 	}
 
-	ServerSelectSection::ItemData::ItemData(Multiplayer::ServerDesc&& desc)
+	ServerSelectSection::ItemData::ItemData(Multiplayer::ServerDescription&& desc)
 		: Desc(std::move(desc))
 	{
 	}

Sources/Jazz2/UI/Menu/ServerSelectSection.h

@@ -21,14 +21,14 @@ namespace Jazz2::UI::Menu
 		void OnDrawClipped(Canvas* canvas) override;
 		void OnTouchEvent(const TouchEvent& event, Vector2i viewSize) override;
 
-		void OnServerFound(Multiplayer::ServerDesc&& desc) override;
+		void OnServerFound(Multiplayer::ServerDescription&& desc) override;
 
 	private:
 		struct ItemData {
-			Multiplayer::ServerDesc Desc;
+			Multiplayer::ServerDescription Desc;
 			float Y;
 
-			ItemData(Multiplayer::ServerDesc&& desc);
+			ItemData(Multiplayer::ServerDescription&& desc);
 		};
 
 		static constexpr std::int32_t ItemHeight = 20;

Sources/nCine/Base/Random.h

@@ -38,7 +38,7 @@ namespace nCine
 		/// Faster but less uniform version of `real()`
 		float FastFloat(float min, float max) noexcept;
 
-		/// Gnerates a 128-bit unique UUID
+		/// Gnerates a 128-bit unique identifier
 		void Uuid(Containers::StaticArrayView<16, std::uint8_t> result);
 
 		template<class T>