Loading config/Doxyfile +10 −9 Original line number Diff line number Diff line Loading @@ -410,19 +410,19 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = YES EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = YES EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file will be # included in the documentation. Loading @@ -436,7 +436,7 @@ EXTRACT_STATIC = NO # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local methods, # which are defined in the implementation section but not in the interface are Loading Loading @@ -650,7 +650,7 @@ SHOW_FILES = YES # Folder Tree View (if specified). # 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 # doxygen should invoke to get the current version for each file (typically from Loading @@ -673,7 +673,8 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = ./config/DoxygenLayout.xml LAYOUT_FILE = # LAYOUT_FILE = ./config/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib Loading Loading @@ -737,7 +738,7 @@ WARN_NO_PARAMDOC = YES # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" WARN_FORMAT = "$text:$file:$line" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard Loading Loading @@ -775,7 +776,7 @@ INPUT_ENCODING = UTF-8 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. FILE_PATTERNS = *.c, *.h FILE_PATTERNS = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. Loading Loading @@ -806,7 +807,7 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = *private* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the Loading src/lib/kinetic_api.h +19 −19 Original line number Diff line number Diff line Loading @@ -72,8 +72,8 @@ bool KineticApi_ConfigureExchange( * @param exchange KineticExchange instance to populate with exchange info * @param request KineticPDU instance to use for request * @param requestMsg KineticMessage instance to use for request * @param reponse KineticPDU instance to use for reponse * @param reponseMsg KineticMessage instance to use for reponse * @param response KineticPDU instance to use for reponse * @param responseMsg KineticMessage instance to use for reponse * @return Returns a configured operation instance */ KineticOperation KineticApi_CreateOperation( Loading @@ -86,7 +86,7 @@ KineticOperation KineticApi_CreateOperation( /** * @brief Executes a NOOP command to test whether the Kinetic Device is operational * * @param exchange KineticOperation instance to use for the operation * @param operation KineticOperation instance to use for the operation * @return Returns the resultant status code */ KineticProto_Status_StatusCode KineticApi_NoOp( Loading Loading
config/Doxyfile +10 −9 Original line number Diff line number Diff line Loading @@ -410,19 +410,19 @@ LOOKUP_CACHE_SIZE = 0 # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = YES EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = YES EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file will be # included in the documentation. Loading @@ -436,7 +436,7 @@ EXTRACT_STATIC = NO # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local methods, # which are defined in the implementation section but not in the interface are Loading Loading @@ -650,7 +650,7 @@ SHOW_FILES = YES # Folder Tree View (if specified). # 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 # doxygen should invoke to get the current version for each file (typically from Loading @@ -673,7 +673,8 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = ./config/DoxygenLayout.xml LAYOUT_FILE = # LAYOUT_FILE = ./config/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib Loading Loading @@ -737,7 +738,7 @@ WARN_NO_PARAMDOC = YES # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" WARN_FORMAT = "$text:$file:$line" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard Loading Loading @@ -775,7 +776,7 @@ INPUT_ENCODING = UTF-8 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. FILE_PATTERNS = *.c, *.h FILE_PATTERNS = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. Loading Loading @@ -806,7 +807,7 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = *private* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the Loading
src/lib/kinetic_api.h +19 −19 Original line number Diff line number Diff line Loading @@ -72,8 +72,8 @@ bool KineticApi_ConfigureExchange( * @param exchange KineticExchange instance to populate with exchange info * @param request KineticPDU instance to use for request * @param requestMsg KineticMessage instance to use for request * @param reponse KineticPDU instance to use for reponse * @param reponseMsg KineticMessage instance to use for reponse * @param response KineticPDU instance to use for reponse * @param responseMsg KineticMessage instance to use for reponse * @return Returns a configured operation instance */ KineticOperation KineticApi_CreateOperation( Loading @@ -86,7 +86,7 @@ KineticOperation KineticApi_CreateOperation( /** * @brief Executes a NOOP command to test whether the Kinetic Device is operational * * @param exchange KineticOperation instance to use for the operation * @param operation KineticOperation instance to use for the operation * @return Returns the resultant status code */ KineticProto_Status_StatusCode KineticApi_NoOp( Loading