From a715389a8b997f4e5372d4eaf7524a6562c1869f Mon Sep 17 00:00:00 2001 From: Juan Antonio Date: Fri, 22 Dec 2023 21:14:41 +0100 Subject: [PATCH] Add Doxygen configuration file and makefile target It can be used to generate sometimes useful call-graphs. --- .gitignore | 3 ++- Doxyfile | 17 +++++++++++++++++ Makefile | 5 ++++- 3 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 Doxyfile diff --git a/.gitignore b/.gitignore index 94a10a7..3742636 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,5 @@ firmware /compiled-firmware .cache compile_commands.json -.vscode \ No newline at end of file +.vscode +/docs diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..48cd30b --- /dev/null +++ b/Doxyfile @@ -0,0 +1,17 @@ +OUTPUT_DIRECTORY = docs +GENERATE_LATEX = NO +GENERATE_RTF = NO +GENERATE_MAN = NO +OPTIMIZE_OUTPUT_FOR_C = YES +HAVE_DOT = YES +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +CALL_GRAPH = YES +CALLER_GRAPH = YES +DISABLE_INDEX = YES +GENERATE_TREEVIEW = YES +RECURSIVE = YES +COLLABORATION_GRAPH = YES +GRAPHICAL_HIERARCHY = YES +DOT_MULTI_TARGETS = YES diff --git a/Makefile b/Makefile index 58d7c84..85cfa7f 100644 --- a/Makefile +++ b/Makefile @@ -178,7 +178,7 @@ else # unix RM = rm -f FixPath = $1 WHERE = which - NULL_OUTPUT = /dev/null + NULL_OUTPUT = /dev/null endif AS = arm-none-eabi-gcc @@ -441,3 +441,6 @@ bsp/dp32g030/%.h: hardware/dp32g030/%.def clean: $(RM) $(call FixPath, $(TARGET).bin $(TARGET).packed.bin $(TARGET) $(OBJS) $(DEPS)) + +doxygen: + doxygen