From 9fef21457931fbd7db43a0653cec4f42b7a526f5 Mon Sep 17 00:00:00 2001 From: Martin Taibr Date: Mon, 6 Apr 2020 21:45:32 +0000 Subject: [PATCH] Update Programming Tips --- Programming-Tips.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Programming-Tips.md b/Programming-Tips.md index 8b1efff..972ae2b 100644 --- a/Programming-Tips.md +++ b/Programming-Tips.md @@ -68,6 +68,12 @@ prvm_globalwatchpoint server prvm_edictwatchpoint server ``` +### Doxygen + +[This](https://timepath.github.io/scratchspace/index.html) is generated as part of [CI on xonotic-data.pk3dir](https://gitlab.com/xonotic/xonotic-data.pk3dir/blob/master/.gitlab-ci.yml) - you can search functions, "classes", globals, etc. + +Note that it might be incomplete or incorrect because Doxygen doesn't understand all of QC's constructs and our code heavily uses macros. + ### 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). -- 2.39.2