m/grafX2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Generate doxygen doc in doc/doxygen with make

Browse Source
This commit is contained in:
Thomas Bernard 2018-07-12 13:04:29 +02:00
parent 244e856e9f
commit 65564d653f
4 changed files with 33 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Makefile
View File

@ -3,10 +3,12 @@ OPT = WIN32CROSS=1 \
endif endif
.PHONY: all tools grafx2 ziprelease 3rdparty win32installer .PHONY: all tools grafx2 ziprelease 3rdparty win32installer doc doxygen
all: grafx2 tools all: grafx2 tools
doc: doxygen
grafx2: grafx2:
$(OPT)$(MAKE) -C src/ $(OPT)$(MAKE) -C src/
@ -21,3 +23,6 @@ tools:
win32installer: win32installer:
$(MAKE) -C install/ $(MAKE) -C install/
doxygen:
$(MAKE) -C tools/ doxygen

7
src/Makefile
View File

@ -642,7 +642,7 @@ endif
### And now for the real build rules ### ### And now for the real build rules ###
.PHONY : all debug release clean depend force install uninstall valgrind .PHONY : all debug release clean depend force install uninstall valgrind doc doxygen
# This is the list of the objects we want to build. Dependancies are built by "make depend" automatically. # This is the list of the objects we want to build. Dependancies are built by "make depend" automatically.
OBJS = main.o init.o graph.o $(APIOBJ) misc.o special.o \ OBJS = main.o init.o graph.o $(APIOBJ) misc.o special.o \
@ -967,4 +967,9 @@ endif
valgrind: $(BIN) valgrind: $(BIN)
valgrind --suppressions=../valgrind.grafx2.suppr --leak-check=full --show-leak-kinds=all --num-callers=20 $(BIN) valgrind --suppressions=../valgrind.grafx2.suppr --leak-check=full --show-leak-kinds=all --num-callers=20 $(BIN)
doc: doxygen
doxygen:
$(MAKE) -C ../tools doxygen
-include Makefile.dep -include Makefile.dep

8
tools/Doxyfile
View File

@ -44,7 +44,7 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short. # quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = PROJECT_BRIEF = "The ultimate 256-color painting program"
# With the PROJECT_LOGO tag one can specify an logo or icon that is included in # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
# the documentation. The maximum height of the logo should not exceed 55 pixels # the documentation. The maximum height of the logo should not exceed 55 pixels
@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If # entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used. # left blank the current directory will be used.
OUTPUT_DIRECTORY = out OUTPUT_DIRECTORY = ../doc/doxygen
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and # directories (in 2 levels) under the output directory of each output format and
@ -753,7 +753,7 @@ WARN_LOGFILE =
# spaces. # spaces.
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = INPUT = ../src
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@ -804,7 +804,7 @@ EXCLUDE_SYMLINKS = NO
# Note that the wildcards are matched against the file with absolute path, so to # Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/* # exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS = SDLMain.* \ EXCLUDE_PATTERNS = recoil.* \
*.py *.py
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

18
tools/Makefile
View File

@ -1,4 +1,11 @@
.PHONY: all gifanalyzer sdl_image_test test_iff DOXYGEN = doxygen
GIT_REVISION = $(shell cat ../src/version.c | cut -f 2 -d '"')
LABEL = $(shell cat ../src/pversion.c | cut -f 2 -d '"')
VERSION = $(subst wip.,wip,$(LABEL).$(GIT_REVISION))
SOURCES = $(wildcard ../src/*.c) $(wildcard ../src/*.h)
.PHONY: all gifanalyzer sdl_image_test test_iff doxygen
all: gifanalyzer sdl_image_test test_iff all: gifanalyzer sdl_image_test test_iff
@ -10,3 +17,12 @@ sdl_image_test:
test_iff: test_iff:
$(MAKE) -C $@ $(MAKE) -C $@
doxygen: ../doc/doxygen/html/index.html
../doc/doxygen/html/index.html: Doxyfile $(SOURCES)
$(DOXYGEN)
Doxyfile: ../src/version.c ../src/pversion.c
sed -e 's/^\(PROJECT_NUMBER[ ]*=[ ]*\).*$$/\1 "$(VERSION)"/' $@ > $@.tmp
mv $@.tmp $@