comment about doxygen

[xonotic/xonotic-data.pk3dir.git] / .gitlab-ci.yml

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 2a26756c55f5bb7840047adfa2163d3d062b07fa..8724d06617940c0ed8cf76c67ad0fc94a25cb5a9 100644 (file)
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -56,6 +56,9 @@ test_sv_unit:
       done < <(${ENGINE} +developer 1 +map gitlab-ci +sv_cmd runtest +exit)
     - exit 1
 
+# NOTE: The generated docs are incomplete - they don't contain code behind SVQC CSQC MENUQC GAMEQC ifdefs.
+# With them added to PREDEFINED, it would take over half an hour to generate the docs and even then
+# they might not be complete. Doxygen doesn't handle #elif and might not understand some QC definitions.
 doxygen:  # rename to 'pages' when gitlab.com allows pages to exceed 100MiB
   stage: deploy
   script: