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 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/b15f.cpp Source File +B15F: drv/b15f.cpp Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/b15f_8h_source.html b/docs/html/b15f_8h_source.html index 4dffe52..030198d 100644 --- a/docs/html/b15f_8h_source.html +++ b/docs/html/b15f_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/b15f.h Source File +B15F: drv/b15f.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/classB15F.html b/docs/html/classB15F.html index 34fbd28..d2c9e9b 100644 --- a/docs/html/classB15F.html +++ b/docs/html/classB15F.html @@ -866,8 +866,8 @@ constexpr static uint32_t 

The documentation for this class was generated from the following files: diff --git a/docs/html/classDot.html b/docs/html/classDot.html index 924f414..537f60a 100644 --- a/docs/html/classDot.html +++ b/docs/html/classDot.html @@ -89,8 +89,8 @@ uint8_t getCurve (void

Definition at line 7 of file dot.h.


The documentation for this class was generated from the following files: diff --git a/docs/html/classDriverException.html b/docs/html/classDriverException.html index 9d9654b..1f469b3 100644 --- a/docs/html/classDriverException.html +++ b/docs/html/classDriverException.html @@ -99,7 +99,7 @@ std::string msg_<

Definition at line 8 of file driverexception.h.


The documentation for this class was generated from the following file: diff --git a/docs/html/classPlottyFile.html b/docs/html/classPlottyFile.html index a0129e7..e3e9672 100644 --- a/docs/html/classPlottyFile.html +++ b/docs/html/classPlottyFile.html @@ -161,8 +161,8 @@ void startPlotty (std:

Definition at line 17 of file plottyfile.h.


The documentation for this class was generated from the following files: diff --git a/docs/html/classTimeoutException.html b/docs/html/classTimeoutException.html index d54eaae..8419517 100644 --- a/docs/html/classTimeoutException.html +++ b/docs/html/classTimeoutException.html @@ -102,7 +102,7 @@ int m_timeout

Definition at line 8 of file timeoutexception.h.


The documentation for this class was generated from the following file: diff --git a/docs/html/classUSART.html b/docs/html/classUSART.html index 3321499..965f784 100644 --- a/docs/html/classUSART.html +++ b/docs/html/classUSART.html @@ -488,8 +488,8 @@ constexpr static uint8_t B
The documentation for this class was generated from the following files: diff --git a/docs/html/classUSARTException.html b/docs/html/classUSARTException.html index 4f565a7..956a359 100644 --- a/docs/html/classUSARTException.html +++ b/docs/html/classUSARTException.html @@ -99,7 +99,7 @@ std::string msg

Definition at line 9 of file usartexception.h.


The documentation for this class was generated from the following file: diff --git a/docs/html/classView.html b/docs/html/classView.html index 2a9bd26..cdc2f42 100644 --- a/docs/html/classView.html +++ b/docs/html/classView.html @@ -146,8 +146,8 @@ constexpr static int KEY_E

Definition at line 17 of file view.h.


The documentation for this class was generated from the following files: diff --git a/docs/html/classViewInfo.html b/docs/html/classViewInfo.html index 3689413..fbbb1af 100644 --- a/docs/html/classViewInfo.html +++ b/docs/html/classViewInfo.html @@ -174,8 +174,8 @@ static std::vector< std::string > 

Definition at line 6 of file view_info.h.


The documentation for this class was generated from the following files: diff --git a/docs/html/classViewMonitor.html b/docs/html/classViewMonitor.html index c212af2..c2eff59 100644 --- a/docs/html/classViewMonitor.html +++ b/docs/html/classViewMonitor.html @@ -186,8 +186,8 @@ constexpr static int KEY_E

Definition at line 11 of file view_monitor.h.


The documentation for this class was generated from the following files: diff --git a/docs/html/classViewPromt.html b/docs/html/classViewPromt.html index ac80eed..ea57bd0 100644 --- a/docs/html/classViewPromt.html +++ b/docs/html/classViewPromt.html @@ -194,8 +194,8 @@ static std::vector< std::string > 

Definition at line 8 of file view_promt.h.


The documentation for this class was generated from the following files: diff --git a/docs/html/classViewSelection.html b/docs/html/classViewSelection.html index a635beb..cd005bb 100644 --- a/docs/html/classViewSelection.html +++ b/docs/html/classViewSelection.html @@ -161,8 +161,8 @@ static std::vector< std::string > 

Definition at line 8 of file view_selection.h.


The documentation for this class was generated from the following files: diff --git a/docs/html/cli_8cpp_source.html b/docs/html/cli_8cpp_source.html index b928194..39da510 100644 --- a/docs/html/cli_8cpp_source.html +++ b/docs/html/cli_8cpp_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/cli.cpp Source File +B15F: cli.cpp Source File @@ -46,6 +46,7 @@ $(function() { }); /* @license-end */ +
- -
cli.cpp
diff --git a/docs/html/dir_2e5593c9005d4dbc14b64af69adefad4.html b/docs/html/dir_1788f8309b1a812dcb800a185471cf6c.html similarity index 88% rename from docs/html/dir_2e5593c9005d4dbc14b64af69adefad4.html rename to docs/html/dir_1788f8309b1a812dcb800a185471cf6c.html index f338037..f35095c 100644 --- a/docs/html/dir_2e5593c9005d4dbc14b64af69adefad4.html +++ b/docs/html/dir_1788f8309b1a812dcb800a185471cf6c.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui Directory Reference +B15F: ui Directory Reference @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/dir_56ea320f36428fc096e6ea8f45d8dae0.html b/docs/html/dir_56ea320f36428fc096e6ea8f45d8dae0.html deleted file mode 100644 index a5bdc3f..0000000 --- a/docs/html/dir_56ea320f36428fc096e6ea8f45d8dae0.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - -B15F: /home/famulus/Dokumente/b15f/control Directory Reference - - - - - - - - - -
-
- - - - - - -
-
B15F -
-
Board 15 Famulus Edition
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
control Directory Reference
-
-
- - -

-Directories

-
- - - - diff --git a/docs/html/dir_81b0a61688244456393c2abc7725ec59.html b/docs/html/dir_587c94d866dbb2f408f78cf41f9b2f8d.html similarity index 88% rename from docs/html/dir_81b0a61688244456393c2abc7725ec59.html rename to docs/html/dir_587c94d866dbb2f408f78cf41f9b2f8d.html index 89b9de6..10f6872 100644 --- a/docs/html/dir_81b0a61688244456393c2abc7725ec59.html +++ b/docs/html/dir_587c94d866dbb2f408f78cf41f9b2f8d.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv Directory Reference +B15F: drv Directory Reference @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/dir_5e190edae4b019e7e1b870accd701baf.html b/docs/html/dir_5e190edae4b019e7e1b870accd701baf.html deleted file mode 100644 index 8d97d59..0000000 --- a/docs/html/dir_5e190edae4b019e7e1b870accd701baf.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - -B15F: /home/famulus/Dokumente/b15f/control/src Directory Reference - - - - - - - - - -
-
- - - - - - -
-
B15F -
-
Board 15 Famulus Edition
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
src Directory Reference
-
-
- - -

-Directories

-
- - - - diff --git a/docs/html/dot_8cpp_source.html b/docs/html/dot_8cpp_source.html index 98c9a6b..b5442fc 100644 --- a/docs/html/dot_8cpp_source.html +++ b/docs/html/dot_8cpp_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/dot.cpp Source File +B15F: drv/dot.cpp Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/dot_8h_source.html b/docs/html/dot_8h_source.html index 1f34539..695f88e 100644 --- a/docs/html/dot_8h_source.html +++ b/docs/html/dot_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/dot.h Source File +B15F: drv/dot.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/driverexception_8h_source.html b/docs/html/driverexception_8h_source.html index c9aca1e..a9c7385 100644 --- a/docs/html/driverexception_8h_source.html +++ b/docs/html/driverexception_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/driverexception.h Source File +B15F: drv/driverexception.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/files.html b/docs/html/files.html index 83d0df3..e4b7368 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -67,35 +67,33 @@ $(function() {
Here is a list of all documented files with brief descriptions:
-
[detail level 1234]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - +
[detail level 12]
  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
diff --git a/docs/html/plottyfile_8cpp_source.html b/docs/html/plottyfile_8cpp_source.html index d176d9d..75db2c6 100644 --- a/docs/html/plottyfile_8cpp_source.html +++ b/docs/html/plottyfile_8cpp_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/plottyfile.cpp Source File +B15F: drv/plottyfile.cpp Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/plottyfile_8h_source.html b/docs/html/plottyfile_8h_source.html index ae5dfa1..a263325 100644 --- a/docs/html/plottyfile_8h_source.html +++ b/docs/html/plottyfile_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/plottyfile.h Source File +B15F: drv/plottyfile.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/search/all_f.html b/docs/html/search/all_f.html deleted file mode 100644 index ca42a52..0000000 --- a/docs/html/search/all_f.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - -
-
Loading...
-
- -
Searching...
-
No Matches
- -
- - diff --git a/docs/html/search/all_f.js b/docs/html/search/all_f.js deleted file mode 100644 index 88b07d9..0000000 --- a/docs/html/search/all_f.js +++ /dev/null @@ -1,5 +0,0 @@ -var searchData= -[ - ['writebyte',['writeByte',['../classUSART.html#a60eadbe9956bab8144ee96d89eacd9f5',1,'USART']]], - ['writeint',['writeInt',['../classUSART.html#a78b30d9aa863f38745e982860392599a',1,'USART']]] -]; diff --git a/docs/html/search/functions_c.html b/docs/html/search/functions_c.html deleted file mode 100644 index a1a1437..0000000 --- a/docs/html/search/functions_c.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - -
-
Loading...
-
- -
Searching...
-
No Matches
- -
- - diff --git a/docs/html/search/functions_c.js b/docs/html/search/functions_c.js deleted file mode 100644 index 88b07d9..0000000 --- a/docs/html/search/functions_c.js +++ /dev/null @@ -1,5 +0,0 @@ -var searchData= -[ - ['writebyte',['writeByte',['../classUSART.html#a60eadbe9956bab8144ee96d89eacd9f5',1,'USART']]], - ['writeint',['writeInt',['../classUSART.html#a78b30d9aa863f38745e982860392599a',1,'USART']]] -]; diff --git a/docs/html/timeoutexception_8h_source.html b/docs/html/timeoutexception_8h_source.html index d7c2fa7..cfb9642 100644 --- a/docs/html/timeoutexception_8h_source.html +++ b/docs/html/timeoutexception_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/timeoutexception.h Source File +B15F: drv/timeoutexception.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/ui_8cpp_source.html b/docs/html/ui_8cpp_source.html index ef02300..07d853b 100644 --- a/docs/html/ui_8cpp_source.html +++ b/docs/html/ui_8cpp_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/ui.cpp Source File +B15F: ui/ui.cpp Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/ui_8h_source.html b/docs/html/ui_8h_source.html index bc5857e..4edb2a9 100644 --- a/docs/html/ui_8h_source.html +++ b/docs/html/ui_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/ui.h Source File +B15F: ui/ui.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/usart_8cpp_source.html b/docs/html/usart_8cpp_source.html index c638206..87f2c09 100644 --- a/docs/html/usart_8cpp_source.html +++ b/docs/html/usart_8cpp_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/usart.cpp Source File +B15F: drv/usart.cpp Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/usart_8h_source.html b/docs/html/usart_8h_source.html index c6776a3..7c8572b 100644 --- a/docs/html/usart_8h_source.html +++ b/docs/html/usart_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/usart.h Source File +B15F: drv/usart.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/usartexception_8h_source.html b/docs/html/usartexception_8h_source.html index d88ec8c..aa66137 100644 --- a/docs/html/usartexception_8h_source.html +++ b/docs/html/usartexception_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/drv/usartexception.h Source File +B15F: drv/usartexception.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/view_8cpp_source.html b/docs/html/view_8cpp_source.html index a406dcc..bb203a4 100644 --- a/docs/html/view_8cpp_source.html +++ b/docs/html/view_8cpp_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/view.cpp Source File +B15F: ui/view.cpp Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/view_8h_source.html b/docs/html/view_8h_source.html index 7a64b63..0cdb246 100644 --- a/docs/html/view_8h_source.html +++ b/docs/html/view_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/view.h Source File +B15F: ui/view.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/view__info_8cpp_source.html b/docs/html/view__info_8cpp_source.html index c58cc89..aaf6b4c 100644 --- a/docs/html/view__info_8cpp_source.html +++ b/docs/html/view__info_8cpp_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/view_info.cpp Source File +B15F: ui/view_info.cpp Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/view__info_8h_source.html b/docs/html/view__info_8h_source.html index 9976d00..0cdd6e1 100644 --- a/docs/html/view__info_8h_source.html +++ b/docs/html/view__info_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/view_info.h Source File +B15F: ui/view_info.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/view__monitor_8cpp_source.html b/docs/html/view__monitor_8cpp_source.html index 0bed7a8..4513007 100644 --- a/docs/html/view__monitor_8cpp_source.html +++ b/docs/html/view__monitor_8cpp_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/view_monitor.cpp Source File +B15F: ui/view_monitor.cpp Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/view__monitor_8h_source.html b/docs/html/view__monitor_8h_source.html index cce433a..e224df6 100644 --- a/docs/html/view__monitor_8h_source.html +++ b/docs/html/view__monitor_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/view_monitor.h Source File +B15F: ui/view_monitor.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/view__promt_8cpp_source.html b/docs/html/view__promt_8cpp_source.html index 01dfefd..ce44e4d 100644 --- a/docs/html/view__promt_8cpp_source.html +++ b/docs/html/view__promt_8cpp_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/view_promt.cpp Source File +B15F: ui/view_promt.cpp Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/view__promt_8h_source.html b/docs/html/view__promt_8h_source.html index b97325d..f09c0c1 100644 --- a/docs/html/view__promt_8h_source.html +++ b/docs/html/view__promt_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/view_promt.h Source File +B15F: ui/view_promt.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/view__selection_8cpp_source.html b/docs/html/view__selection_8cpp_source.html index 528cbee..4a45641 100644 --- a/docs/html/view__selection_8cpp_source.html +++ b/docs/html/view__selection_8cpp_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/view_selection.cpp Source File +B15F: ui/view_selection.cpp Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/html/view__selection_8h_source.html b/docs/html/view__selection_8h_source.html index 93bdbaf..9cfd46e 100644 --- a/docs/html/view__selection_8h_source.html +++ b/docs/html/view__selection_8h_source.html @@ -5,7 +5,7 @@ -B15F: /home/famulus/Dokumente/b15f/control/src/ui/view_selection.h Source File +B15F: ui/view_selection.h Source File @@ -62,7 +62,7 @@ $(function() {
diff --git a/docs/run-doygen b/docs/run-doygen deleted file mode 100755 index dfd62cc..0000000 --- a/docs/run-doygen +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/sh -../control/bin/doxygen doxygen-cfg