From: Martin Taibr <taibr.martin@gmail.com>
Date: Wed, 25 Sep 2019 08:38:20 +0000 (+0200)
Subject: comment about doxygen
X-Git-Tag: xonotic-v0.8.5~1278
X-Git-Url: https://git.rm.cloudns.org/?a=commitdiff_plain;h=91785d36c0dcb22a04ec21b1c2ad5f66b2879541;p=xonotic%2Fxonotic-data.pk3dir.git

comment about doxygen
---

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 2a26756c5..8724d0661 100644
--- 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: