Mirrors/knx
1
0
Fork 0
mirror of https://github.com/thelsing/knx.git synced 2024-12-18 19:08:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into directories

Browse Source
This commit is contained in:
Thomas Kunze 2024-08-16 22:22:22 +02:00
commit b59b37a462
5 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.readthedocs.yaml
View File

@ -13,6 +13,9 @@ build:
# nodejs: "20" # nodejs: "20"
# rust: "1.70" # rust: "1.70"
# golang: "1.20" # golang: "1.20"
apt_packages:
- graphviz
- openjdk-11-jre
# Build documentation in the "docs/" directory with Sphinx # Build documentation in the "docs/" directory with Sphinx
sphinx: sphinx:

2
doc/Doxyfile
View File

@ -2072,7 +2072,7 @@ PERLMOD_MAKEVAR_PREFIX =
# C-preprocessor directives found in the sources and include files. # C-preprocessor directives found in the sources and include files.
# The default value is: YES. # The default value is: YES.
ENABLE_PREPROCESSING = YES ENABLE_PREPROCESSING = NO
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
# in the source code. If set to NO, only conditional compilation will be # in the source code. If set to NO, only conditional compilation will be

4
doc/conf.py
View File

@ -26,7 +26,7 @@ import subprocess, os
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
if read_the_docs_build: if read_the_docs_build:
subprocess.call('wget -O plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2023.10/plantuml-1.2023.10.jar', shell=True) subprocess.call('wget -O plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2024.6/plantuml.jar', shell=True)
subprocess.call('doxygen', shell=True) subprocess.call('doxygen', shell=True)
subprocess.call('mv ./doxyoutput/html/index.html ./doxyoutput/html/index_doxygen.html', shell=True) subprocess.call('mv ./doxyoutput/html/index.html ./doxyoutput/html/index_doxygen.html', shell=True)
@ -475,4 +475,4 @@ epub_exclude_files = ['search.html']
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None} # intersphinx_mapping = {'https://docs.python.org/': None}

1
doc/requirements.txt
View File

@ -1,3 +1,4 @@
exhale exhale
breathe breathe
sphinx>=2.1.2 sphinx>=2.1.2
sphinx-rtd-theme

19
src/knx.h
View File

@ -3,14 +3,9 @@
* This diagramm shows the most important classes of a normal KNX device. * This diagramm shows the most important classes of a normal KNX device.
@startuml @startuml
skinparam monochrome true skinparam monochrome true
skinparam componentStyle uml2 skinparam componentStyle uml2
note top of knx
Class diagram for a
<b><color:royalBlue>normal KNX device</color>
end note
package "knx" { package "knx" {
class BusAccessUnit [[class_bus_access_unit.html]] class BusAccessUnit [[class_bus_access_unit.html]]
class DeviceObject [[class_device_object.html]] class DeviceObject [[class_device_object.html]]
@ -133,7 +128,12 @@ class Stm32Platform [[class_stm32_platform.html]]
ArduinoPlatform<|--Stm32Platform ArduinoPlatform<|--Stm32Platform
class LinuxPlatform [[class_linux_platform.html]] class LinuxPlatform [[class_linux_platform.html]]
LinuxPlatform--|>Platform LinuxPlatform--|>Platform
class CC1310Platform [[class_cc1310_platform.html]]
CC1310Platform--|>Platform
class RP2040ArduinoPlatform [[class_rp2040_arduino_platform.html]]
RP2040ArduinoPlatform--|>ArduinoPlatform
} }
package frontend package frontend
{ {
class KnxFacade [[class_knx_facade.html]] class KnxFacade [[class_knx_facade.html]]
@ -149,10 +149,6 @@ knx-->Platform
skinparam monochrome true skinparam monochrome true
skinparam componentStyle uml2 skinparam componentStyle uml2
note top of knx
Class diagram for a
<b><color:royalBlue>KNX coupler</color>
end note
package "knx" { package "knx" {
class BusAccessUnit [[class_bus_access_unit.html]] class BusAccessUnit [[class_bus_access_unit.html]]
class DeviceObject [[class_device_object.html]] class DeviceObject [[class_device_object.html]]
@ -234,7 +230,12 @@ class Stm32Platform [[class_stm32_platform.html]]
ArduinoPlatform<|--Stm32Platform ArduinoPlatform<|--Stm32Platform
class LinuxPlatform [[class_linux_platform.html]] class LinuxPlatform [[class_linux_platform.html]]
LinuxPlatform--|>Platform LinuxPlatform--|>Platform
class CC1310Platform [[class_cc1310_platform.html]]
CC1310Platform--|>Platform
class RP2040ArduinoPlatform [[class_rp2040_arduino_platform.html]]
RP2040ArduinoPlatform--|>ArduinoPlatform
} }
package frontend package frontend
{ {
class KnxFacade [[class_knx_facade.html]] class KnxFacade [[class_knx_facade.html]]