mirror of
				https://github.com/thelsing/knx.git
				synced 2025-10-26 10:26:25 +01:00 
			
		
		
		
	change documentation
This commit is contained in:
		
							parent
							
								
									047e0e9d35
								
							
						
					
					
						commit
						069bbcde8c
					
				
							
								
								
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							@ -262,3 +262,4 @@ __pycache__/
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
**/CodeDB
 | 
					**/CodeDB
 | 
				
			||||||
**/VisualGDBCache
 | 
					**/VisualGDBCache
 | 
				
			||||||
 | 
					doc/build
 | 
				
			||||||
							
								
								
									
										28
									
								
								doc/Doxyfile
									
									
									
									
									
								
							
							
						
						
									
										28
									
								
								doc/Doxyfile
									
									
									
									
									
								
							@ -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          = synopsis
 | 
					PROJECT_BRIEF          = "ETS configurable knx-stack"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 | 
					# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 | 
				
			||||||
# in the documentation. The maximum height of the logo should not exceed 55
 | 
					# in the documentation. The maximum height of the logo should not exceed 55
 | 
				
			||||||
@ -680,7 +680,7 @@ SHOW_FILES             = YES
 | 
				
			|||||||
# Folder Tree View (if specified).
 | 
					# Folder Tree View (if specified).
 | 
				
			||||||
# The default value is: YES.
 | 
					# The default value is: YES.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
SHOW_NAMESPACES        = YES
 | 
					SHOW_NAMESPACES        = NO
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
 | 
					# The FILE_VERSION_FILTER tag can be used to specify a program or script that
 | 
				
			||||||
# doxygen should invoke to get the current version for each file (typically from
 | 
					# doxygen should invoke to get the current version for each file (typically from
 | 
				
			||||||
@ -790,7 +790,7 @@ WARN_LOGFILE           =
 | 
				
			|||||||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 | 
					# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 | 
				
			||||||
# 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
 | 
				
			||||||
@ -873,8 +873,7 @@ RECURSIVE              = YES
 | 
				
			|||||||
# Note that relative paths are relative to the directory from which doxygen is
 | 
					# Note that relative paths are relative to the directory from which doxygen is
 | 
				
			||||||
# run.
 | 
					# run.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
EXCLUDE                = visualstudio \
 | 
					EXCLUDE                = .
 | 
				
			||||||
                         doc
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 | 
					# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 | 
				
			||||||
# directories that are symbolic links (a Unix file system feature) are excluded
 | 
					# directories that are symbolic links (a Unix file system feature) are excluded
 | 
				
			||||||
@ -893,7 +892,12 @@ EXCLUDE_SYMLINKS       = NO
 | 
				
			|||||||
EXCLUDE_PATTERNS       = VisualGDB \
 | 
					EXCLUDE_PATTERNS       = VisualGDB \
 | 
				
			||||||
                         VisualGDBCache \
 | 
					                         VisualGDBCache \
 | 
				
			||||||
                         pybind11 \
 | 
					                         pybind11 \
 | 
				
			||||||
                         visualstudio
 | 
					                         visualstudio \
 | 
				
			||||||
 | 
					                         main.cpp \
 | 
				
			||||||
 | 
					                         *.py \
 | 
				
			||||||
 | 
					                         Debug \
 | 
				
			||||||
 | 
					                         gcc_Debug.h \
 | 
				
			||||||
 | 
					                         gcc_Release.h
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# 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
 | 
				
			||||||
# (namespaces, classes, functions, etc.) that should be excluded from the
 | 
					# (namespaces, classes, functions, etc.) that should be excluded from the
 | 
				
			||||||
@ -910,7 +914,7 @@ EXCLUDE_SYMBOLS        =
 | 
				
			|||||||
# that contain example code fragments that are included (see the \include
 | 
					# that contain example code fragments that are included (see the \include
 | 
				
			||||||
# command).
 | 
					# command).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
EXAMPLE_PATH           = 
 | 
					EXAMPLE_PATH           = ../examples
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
 | 
					# If the value of the EXAMPLE_PATH tag contains directories, you can use the
 | 
				
			||||||
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
 | 
					# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
 | 
				
			||||||
@ -924,7 +928,7 @@ EXAMPLE_PATTERNS       = *
 | 
				
			|||||||
# irrespective of the value of the RECURSIVE tag.
 | 
					# irrespective of the value of the RECURSIVE tag.
 | 
				
			||||||
# The default value is: NO.
 | 
					# The default value is: NO.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
EXAMPLE_RECURSIVE      = NO
 | 
					EXAMPLE_RECURSIVE      = YES
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# The IMAGE_PATH tag can be used to specify one or more files or directories
 | 
					# The IMAGE_PATH tag can be used to specify one or more files or directories
 | 
				
			||||||
# that contain images that are to be included in the documentation (see the
 | 
					# that contain images that are to be included in the documentation (see the
 | 
				
			||||||
@ -2249,7 +2253,7 @@ HAVE_DOT               = YES
 | 
				
			|||||||
# Minimum value: 0, maximum value: 32, default value: 0.
 | 
					# Minimum value: 0, maximum value: 32, default value: 0.
 | 
				
			||||||
# This tag requires that the tag HAVE_DOT is set to YES.
 | 
					# This tag requires that the tag HAVE_DOT is set to YES.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
DOT_NUM_THREADS        = 0
 | 
					DOT_NUM_THREADS        = 4
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# When you want a differently looking font in the dot files that doxygen
 | 
					# When you want a differently looking font in the dot files that doxygen
 | 
				
			||||||
# generates you can specify the font name using DOT_FONTNAME. You need to make
 | 
					# generates you can specify the font name using DOT_FONTNAME. You need to make
 | 
				
			||||||
@ -2399,7 +2403,7 @@ DIRECTORY_GRAPH        = YES
 | 
				
			|||||||
# The default value is: png.
 | 
					# The default value is: png.
 | 
				
			||||||
# This tag requires that the tag HAVE_DOT is set to YES.
 | 
					# This tag requires that the tag HAVE_DOT is set to YES.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
DOT_IMAGE_FORMAT       = png
 | 
					DOT_IMAGE_FORMAT       = svg
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
 | 
					# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
 | 
				
			||||||
# enable generation of interactive SVG images that allow zooming and panning.
 | 
					# enable generation of interactive SVG images that allow zooming and panning.
 | 
				
			||||||
@ -2490,7 +2494,7 @@ MAX_DOT_GRAPH_DEPTH    = 0
 | 
				
			|||||||
# The default value is: NO.
 | 
					# The default value is: NO.
 | 
				
			||||||
# This tag requires that the tag HAVE_DOT is set to YES.
 | 
					# This tag requires that the tag HAVE_DOT is set to YES.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
DOT_TRANSPARENT        = NO
 | 
					DOT_TRANSPARENT        = YES
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
 | 
					# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
 | 
				
			||||||
# files in one run (i.e. multiple -o and -T options on the command line). This
 | 
					# files in one run (i.e. multiple -o and -T options on the command line). This
 | 
				
			||||||
@ -2499,7 +2503,7 @@ DOT_TRANSPARENT        = NO
 | 
				
			|||||||
# The default value is: NO.
 | 
					# The default value is: NO.
 | 
				
			||||||
# This tag requires that the tag HAVE_DOT is set to YES.
 | 
					# This tag requires that the tag HAVE_DOT is set to YES.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
DOT_MULTI_TARGETS      = NO
 | 
					DOT_MULTI_TARGETS      = YES
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
 | 
					# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
 | 
				
			||||||
# explaining the meaning of the various boxes and arrows in the dot generated
 | 
					# explaining the meaning of the various boxes and arrows in the dot generated
 | 
				
			||||||
 | 
				
			|||||||
@ -6,7 +6,7 @@ class AddressTableObject: public TableObject
 | 
				
			|||||||
{
 | 
					{
 | 
				
			||||||
public:
 | 
					public:
 | 
				
			||||||
    AddressTableObject(Platform& platform);
 | 
					    AddressTableObject(Platform& platform);
 | 
				
			||||||
    void readProperty(PropertyID id, uint32_t start, uint32_t& count, uint8_t* data);
 | 
					    void readProperty(PropertyID id, uint32_t start, uint32_t count, uint8_t *data);
 | 
				
			||||||
    uint16_t entryCount();
 | 
					    uint16_t entryCount();
 | 
				
			||||||
    uint16_t getGa(uint16_t tsap);
 | 
					    uint16_t getGa(uint16_t tsap);
 | 
				
			||||||
    uint16_t getTsap(uint16_t ga);
 | 
					    uint16_t getTsap(uint16_t ga);
 | 
				
			||||||
 | 
				
			|||||||
@ -106,7 +106,6 @@ public:
 | 
				
			|||||||
    * is in 1/100, so a value of 2101 would set a DPT9 float value of 21.01.
 | 
					    * is in 1/100, so a value of 2101 would set a DPT9 float value of 21.01.
 | 
				
			||||||
    * The possible range of the values is -671088.64 to 670760.96.
 | 
					    * The possible range of the values is -671088.64 to 670760.96.
 | 
				
			||||||
    *
 | 
					    *
 | 
				
			||||||
    * @param objno - the ID of the communication object.
 | 
					 | 
				
			||||||
    * @param value - the new value of the communication object in 1/100.
 | 
					    * @param value - the new value of the communication object in 1/100.
 | 
				
			||||||
    *                Use INVALID_DPT_FLOAT for the DPT9 "invalid data" value.
 | 
					    *                Use INVALID_DPT_FLOAT for the DPT9 "invalid data" value.
 | 
				
			||||||
    */
 | 
					    */
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
		Reference in New Issue
	
	Block a user