Skip to content

Commit

Permalink
Add Doxygen configuration file and makefile target
Browse files Browse the repository at this point in the history
It can be used to generate sometimes useful call-graphs.
  • Loading branch information
JuantAldea authored and egzumer committed Dec 24, 2023
1 parent 6f1cabc commit a715389
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ firmware
/compiled-firmware
.cache
compile_commands.json
.vscode
.vscode
/docs
17 changes: 17 additions & 0 deletions Doxyfile
Original file line number Diff line number Diff line change
@@ -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
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -441,3 +441,6 @@ bsp/dp32g030/%.h: hardware/dp32g030/%.def

clean:
$(RM) $(call FixPath, $(TARGET).bin $(TARGET).packed.bin $(TARGET) $(OBJS) $(DEPS))

doxygen:
doxygen

0 comments on commit a715389

Please sign in to comment.