Upload attachment zzz-bai-sounds-v11.pk3

[xonotic/xonotic.wiki.git] / Programming-Tips.md

diff --git a/Programming-Tips.md b/Programming-Tips.md
index 8b1efffb4d9cda9867587cfbc66814ae99223d1f..d05c4b10d0988f1f4572311a6c38775982e7779a 100644 (file)
--- a/Programming-Tips.md
+++ b/Programming-Tips.md
@@ -68,6 +68,12 @@ prvm_globalwatchpoint server
 prvm_edictwatchpoint server
 ```
 
+### Doxygen
+
+Incomplete [Doxygen documentation](https://timepath.github.io/scratchspace/index.html) is generated as part of CI on [xonotic-data.pk3dir](https://gitlab.com/xonotic/xonotic-data.pk3dir) - you can search functions, "classes", globals, etc.
+
+Note that it might be incomplete or incorrect because [Doxygen](https://www.doxygen.nl) doesn't understand all of QC's constructs and our code heavily uses macros. See the `doxygen` section of the [CI file](https://gitlab.com/xonotic/xonotic-data.pk3dir/blob/master/.gitlab-ci.yml) for details what's missing.
+
 ### Tool to find C symbols, functions, declarations and definitions inside source code
 
 For this purpose it's possible to use a text-based tool called [Cscope](https://en.wikipedia.org/wiki/Cscope) together with a GUI (it can be either an application or a plugin for a text editor).