added documentation to makefile
This commit is contained in:
parent
5d7407aded
commit
cffac6757e
49 changed files with 111 additions and 352 deletions
|
@ -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 $@
|
||||
|
|
3
control/src/README.md
Normal file
3
control/src/README.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# Einführung
|
||||
Die wichtigste Klasse für die Steuerung des Board 15 ist [B15F](classB15F.html).
|
||||
Dort befindet sich auch eine Übersicht der verfügbaren Befehle.
|
2545
control/src/doxygen-cfg
Normal file
2545
control/src/doxygen-cfg
Normal file
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue