comment about doxygen
authorMartin Taibr <taibr.martin@gmail.com>
Wed, 25 Sep 2019 08:38:20 +0000 (10:38 +0200)
committerMartin Taibr <taibr.martin@gmail.com>
Wed, 25 Sep 2019 08:38:20 +0000 (10:38 +0200)
.gitlab-ci.yml

index 2a26756..8724d06 100644 (file)
@@ -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: