chore: Doxygen Migration

.gitignore

@@ -12,8 +12,9 @@ extension_api.json
 .vscode/
 
 build
+builds/
 
-testing.*
-testing
+docs/build
+world/
 
-world/
+testing.*

Doxyfile

@@ -0,0 +1,9 @@
+PROJECT_NAME           = "CavernServer"
+OUTPUT_DIRECTORY       = builds/docs
+
+GENERATE_XML           = YES
+XML_OUTPUT             = xml
+GENERATE_HTML          = NO
+FILE_PATTERNS = *.c *.h *.hpp
+INPUT                  = src includes
+RECURSIVE              = YES

docs.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -e
+
+mkdir -p builds/docs
+
+doxygen Doxyfile
+
+cd docs
+sphinx-build -b html source build/html

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_static/doxygen.css

@@ -0,0 +1,30 @@
+.doxygenindex,
+.doxygenclass,
+.doxygennamespace,
+.doxygenfile,
+.doxygenfunction,
+.doxygengroup,
+.doxygenstruct {
+    margin-top: 2rem !important;
+    margin-bottom: 2rem !important;
+    line-height: 1.6;
+}
+
+.doxygenindex p,
+.doxygenclass p,
+.doxygenfile p,
+.doxygenstruct p {
+    margin: 0.6em 0 !important;
+}
+
+dl.cpp,
+dl.c {
+    margin-top: 1.4rem !important;
+    margin-bottom: 1.4rem !important;
+}
+
+div.highlight {
+    padding: 1rem !important;
+    border-radius: 8px;
+    margin: 1rem 0 !important;
+}

docs/source/api.rst

@@ -0,0 +1,5 @@
+API
+===
+
+.. doxygenindex::
+   :project: CavernServer

docs/source/conf.py

@@ -0,0 +1,47 @@
+import os 
+import sys
+
+sys.path.insert(0, os.path.abspath('.'))
+
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'CavernServer'
+copyright = '2025, Cavernfall Interactives'
+author = 'Cavernfall Interactives'
+release = '1.0.0-dev'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+breathe_projects = {
+    "CavernServer": "../../builds/docs/xml"
+}
+breathe_default_project = "CavernServer"
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+extensions = [
+    "breathe",
+]
+
+html_theme = "furo"
+html_static_path = ['_static']
+
+html_css_files = [
+    "doxygen.css"
+]
+
+breathe_default_members = ("members", "undoc-members")

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. CavernServer documentation master file, created by
+   sphinx-quickstart on Sun Nov 16 02:53:19 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to CavernServer's documentation!
+========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

includes/cavernfall/config.hpp

@@ -1,9 +1,26 @@
+/**
+ * @file config.hpp
+ * @brief Definitions for Cavernfall configurations.
+ * @details Usually contains default feature flag values and more.
+ */
+
 #pragma once
 
 #ifndef WORLD_REGION_SIZE
+/**
+ * @brief The side-size of a world region (in terms of chunks).
+ */
 #define WOLRD_REGION_SIZE 8
 #endif
 
 #ifndef WORLD_CHUNK_SIZE
+/**
+ * @brief The side-size of a chunk (in terms of blocks).
+ */
 #define WORLD_CHUNK_SIZE 32
-#endif
+#endif
+
+/**
+ * @brief The total size of a chunk (in terms of blocks).
+ */
+#define WORLD_CHUNK_SIZE_TOTAL WORLD_CHUNK_SIZE * WORLD_CHUNK_SIZE

includes/cavernfall/constants.hpp

@@ -1,13 +1,35 @@
+/**
+ * @file constants.hpp
+ * @details Cavernfall constants definitions.
+ */
+
 #pragma once
 
+/**
+ * @brief The lowest health point an entity can be at.
+ * @details The lowest health value possible before an entity dies.
+ */
 #define HEALTH_POINT_LOWEST 0
 
+/**
+ * @brief The maximum veritcal motion.
+ * @details The maximum vertical motion an entity can do in one motion tick from the velocity.
+ */
 #define MAX_VERTICAL_MOTION_IN_ONE_TICK 0.10
-#define MAX_MOTION_IN_ONE_TICK 0.15
 
-#define CHUNK_SIDE_SIZE 32
-#define CHUNK_SIZE_TOTAL CHUNK_SIDE_SIZE * CHUNK_SIDE_SIZE
-#define CHUNK_MAX_HEIGHT 50
+/**
+ * @brief The maximum horizontal motion.
+ * @details The maximum horizontal motion an entity can do in one motion tick from the velocity.
+ */
+#define MAX_MOTION_IN_ONE_TICK 0.15
 
+/**
+ * @brief The maximum health level of a player.
+ * @deprecated Should be soon removed as it not important enough to be here.
+ */
 #define PLAYER_MAX_HEALTH 100
+
+/**
+ * @brief The player's render distance in terms of chunks.
+ */
 #define PLAYER_RENDER_DISTANCE 8