diff --git a/control/src/Makefile b/control/src/Makefile index cb2b18a..4f40fa5 100644 --- a/control/src/Makefile +++ b/control/src/Makefile @@ -5,6 +5,7 @@ # Environment PATH_COMPILER = g++ +PATH_DOXYGEN = ../bin/doxygen # install paths PATH_BIN = /usr/bin/ @@ -22,6 +23,7 @@ OUT_TMP_PLOTTY = $(PATH_TMP_BIN)/plotty OUT_DRV = $(PATH_LIB)/libb15fdrv.so OUT_CLI = $(PATH_BIN)/b15fcli OUT_PLOTTY = $(PATH_BIN)/plotty +OUT_DOC = ../../docs/html # compiling & linking parameters CFLAGS = -std=c++17 -O3 -Wall -Wextra -fPIC @@ -36,7 +38,7 @@ OBJECTS_CLI = cli.o ui/view.o ui/view_selection.o ui/view_promt.o ui/view_info # *** TARGETS *** -all: drv cli +all: drv cli doc drv: $(OBJECTS_DRV) $(OUT_TMP_DRV) @@ -47,7 +49,11 @@ cli: drv $(OBJECTS_CLI) $(PATH_COMPILER) $(CFLAGS) $(OBJECTS_CLI) -L $(PATH_TMP_LIB) -o $(OUT_TMP_CLI) $(LDFLAGS_CLI) @bash -c 'if [ ! -f "$(OUT_DRV)" ]; then echo -e "\n*** Warning ***: driver not installed\nType \"sudo make install\" to install or update b15fdrv."; fi' -install: all +doc: + @echo "Creating documentation with doxygen.." + $(PATH_DOXYGEN) doxygen-cfg + +install: @echo "Installing driver..." @mkdir -p $(PATH_INCLUDE) cp $(OUT_TMP_DRV) $(OUT_DRV) @@ -71,6 +77,7 @@ help: clean: @echo "Cleaning..." rm -f $(OBJECTS_DRV) $(OBJECTS_CLI) $(OUT_TMP_CLI) $(OUT_TMP_DRV) + rm -rf $(OUT_DOC) .cpp.o: $(PATH_COMPILER) $(CFLAGS) -c $< -o $@ diff --git a/docs/README.md b/control/src/README.md similarity index 100% rename from docs/README.md rename to control/src/README.md diff --git a/docs/doxygen-cfg b/control/src/doxygen-cfg similarity index 99% rename from docs/doxygen-cfg rename to control/src/doxygen-cfg index 629c77c..7093299 100644 --- a/docs/doxygen-cfg +++ b/control/src/doxygen-cfg @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = ../../docs # 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 @@ -827,7 +827,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../control/src README.md +INPUT = # 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 diff --git a/docs/html/b15f_8cpp_source.html b/docs/html/b15f_8cpp_source.html index bf5bcd1..a12e858 100644 --- a/docs/html/b15f_8cpp_source.html +++ b/docs/html/b15f_8cpp_source.html @@ -5,7 +5,7 @@ -
Definition at line 8 of file driverexception.h.
Definition at line 17 of file plottyfile.h.
Definition at line 8 of file timeoutexception.h.
Definition at line 9 of file usartexception.h.
Definition at line 6 of file view_info.h.
Definition at line 11 of file view_monitor.h.
Definition at line 8 of file view_promt.h.
Definition at line 8 of file view_selection.h.
- B15F
-
- Board 15 Famulus Edition
- |
-
- B15F
-
- Board 15 Famulus Edition
- |
-
▼ control | |
▼ src | |
▼ drv | |
b15f.cpp | |
b15f.h | |
dot.cpp | |
dot.h | |
driverexception.h | |
plottyfile.cpp | |
plottyfile.h | |
timeoutexception.h | |
usart.cpp | |
usart.h | |
usartexception.h | |
▼ ui | |
ui.cpp | |
ui.h | |
view.cpp | |
view.h | |
view_info.cpp | |
view_info.h | |
view_monitor.cpp | |
view_monitor.h | |
view_promt.cpp | |
view_promt.h | |
view_selection.cpp | |
view_selection.h | |
cli.cpp |
▼ drv | |
b15f.cpp | |
b15f.h | |
dot.cpp | |
dot.h | |
driverexception.h | |
plottyfile.cpp | |
plottyfile.h | |
timeoutexception.h | |
usart.cpp | |
usart.h | |
usartexception.h | |
▼ ui | |
ui.cpp | |
ui.h | |
view.cpp | |
view.h | |
view_info.cpp | |
view_info.h | |
view_monitor.cpp | |
view_monitor.h | |
view_promt.cpp | |
view_promt.h | |
view_selection.cpp | |
view_selection.h | |
cli.cpp |