From 172a7dd9f2ccc904f0f40e14b88e7504eb981003 Mon Sep 17 00:00:00 2001 From: "Ching-Hsin,Lee" Date: Wed, 22 May 2024 08:19:21 +0000 Subject: [PATCH] Update doxygen to 1.9.6 --- README.md | 2 +- docs/doxygen/config.doxyfile | 49 +++++++++++++--------- docs/doxygen/pages.dox | 56 ++++++++++++++++++++++---- docs/doxygen/portingCellularModule.dox | 6 ++- 4 files changed, 83 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 386325a1..e0bc0e48 100644 --- a/README.md +++ b/README.md @@ -203,7 +203,7 @@ examples for the library API. ## Generating documentation -The Doxygen references were created using Doxygen version 1.9.2. To generate the +The Doxygen references were created using Doxygen version 1.9.6. To generate the Doxygen pages, please run the following command from the root of this repository: diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile index ba8a149a..e3d406bd 100644 --- a/docs/doxygen/config.doxyfile +++ b/docs/doxygen/config.doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.9.5 +# Doxyfile 1.9.6 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -86,7 +86,7 @@ CREATE_SUBDIRS = NO # level increment doubles the number of directories, resulting in 4096 # directories at level 8 which is the default and also the maximum value. The # sub-directories are organized in 2 levels, the first level always has a fixed -# numer of 16 directories. +# number of 16 directories. # Minimum value: 0, maximum value: 8, default value: 8. # This tag requires that the tag CREATE_SUBDIRS is set to YES. @@ -587,7 +587,8 @@ HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO @@ -878,6 +879,14 @@ WARN_IF_INCOMPLETE_DOC = YES WARN_NO_PARAMDOC = NO +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but @@ -1253,10 +1262,11 @@ CLANG_DATABASE_PATH = ALPHABETICAL_INDEX = YES -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = @@ -1335,7 +1345,12 @@ HTML_STYLESHEET = # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = ./docs/doxygen/style.css @@ -1351,17 +1366,13 @@ HTML_EXTRA_STYLESHEET = ./docs/doxygen/style.css HTML_EXTRA_FILES = # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output -# should be rendered with a dark or light theme. Default setting AUTO_LIGHT -# enables light output unless the user preference is dark output. Other options -# are DARK to always use dark mode, LIGHT to always use light mode, AUTO_DARK to -# default to dark mode unless the user prefers light mode, and TOGGLE to let the -# user toggle between dark and light mode via a button. -# Possible values are: LIGHT Always generate light output., DARK Always generate -# dark output., AUTO_LIGHT Automatically set the mode according to the user -# preference, use light mode if no preference is set (the default)., AUTO_DARK -# Automatically set the mode according to the user preference, use dark mode if -# no preference is set. and TOGGLE Allow to user to switch between light and -# dark mode via a button.. +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. # The default value is: AUTO_LIGHT. # This tag requires that the tag GENERATE_HTML is set to YES. diff --git a/docs/doxygen/pages.dox b/docs/doxygen/pages.dox index 981f5b4e..6811a52c 100644 --- a/docs/doxygen/pages.dox +++ b/docs/doxygen/pages.dox @@ -175,6 +175,31 @@ Some configuration settings are C pre-processor constants, and some are function @section CELLULAR_CONFIG_STATIC_SOCKET_CONTEXT_ALLOCATION @copydoc CELLULAR_CONFIG_STATIC_SOCKET_CONTEXT_ALLOCATION +@section CELLULAR_COMMON_AT_COMMAND_TIMEOUT_MS +@copydoc CELLULAR_COMMON_AT_COMMAND_TIMEOUT_MS + +@section CELLULAR_AT_COMMAND_RAW_TIMEOUT_MS +@copydoc CELLULAR_AT_COMMAND_RAW_TIMEOUT_MS + +@section CELLULAR_CONFIG_MAX_PREFIX_STRING_LENGTH +@copydoc CELLULAR_CONFIG_MAX_PREFIX_STRING_LENGTH + +@section CELLULAR_AT_MAX_STRING_SIZE +@copydoc CELLULAR_AT_MAX_STRING_SIZE + +@section CELLULAR_CONFIG_USE_CCID_COMMAND +@copydoc CELLULAR_CONFIG_USE_CCID_COMMAND + +@section CELLULAR_CONFIG_ASSERT +@copydoc CELLULAR_CONFIG_ASSERT + +@section CELLULAR_CONFIG_PLATFORM_FREERTOS +@copydoc CELLULAR_CONFIG_PLATFORM_FREERTOS + +@section CELLULAR_MODEM_NO_EPS_NETWORK +@brief Macro to disable querying evolved packet system (EPS) network registration status in Cellular_CommonGetServiceStatus.
+@note Cellular modem porting can define this macro in cellular_config.h to disable this function.
+ @section cellular_logerror LogError @copydoc LogError @@ -187,10 +212,6 @@ Some configuration settings are C pre-processor constants, and some are function @section cellular_logdebug LogDebug @copydoc LogDebug -@section CELLULAR_MODEM_NO_EPS_NETWORK -@brief Macro to disable querying evolved packet system (EPS) network registration status in Cellular_CommonGetServiceStatus.
-@note Cellular modem porting can define this macro in cellular_config.h to disable this function.
- Default value: undefined */ @@ -305,10 +326,19 @@ Reference the document page for prototype. FreeRTOS Cellular Library makes use of the following OS platform functions.
"cellular_platform.h" is referenced during FreeRTOS Cellular Library compilation.
User of FreeRTOS Cellular Library should provide these APIs and data structures in "cellular_platform.h".
-A default implementation with FreeRTOS is provided in FreeRTOS Labs cellular demo. - - Threads
The following APIs and macros should be provided in cellular_platform.h +A default implementation with FreeRTOS cellular_platform.h is provided in FreeRTOS repository. + - Basic data types and macros
The following data types and macros should be provided in cellular_platform.h. + ``` + #define PlatformBaseType_t BaseType_t + #define PlatformTickType_t TickType_t + #define platformTRUE pdTRUE + #define platformFALSE pdFALSE + #define platformPASS pdPASS + #define platformFAIL pdFAIL + #define platformMAX_DELAY portMAX_DELAY +``` + - Threads
The following APIs and macros should be provided in cellular_platform.h. ``` - bool Platform_CreateDetachedThread( void ( * threadRoutine )( void * ), void * pArgument, int32_t priority, @@ -344,6 +374,7 @@ void PlatformMutex_Unlock( PlatformMutex_t * pMutex ); ``` // Example implementation of FreeRTOS EvengGroup #define PlatformEventGroupHandle_t EventGroupHandle_t +#define PlatformEventBits_t EventBits_t #define PlatformEventGroup_Delete vEventGroupDelete #define PlatformEventGroup_ClearBits xEventGroupClearBits #define PlatformEventGroup_Create xEventGroupCreate @@ -351,7 +382,16 @@ void PlatformMutex_Unlock( PlatformMutex_t * pMutex ); #define PlatformEventGroup_SetBits xEventGroupSetBits #define PlatformEventGroup_SetBitsFromISR xEventGroupSetBitsFromISR #define PlatformEventGroup_WaitBits xEventGroupWaitBits - +``` + - Queue
The following APIs and handle should be provided in cellular_platform.h.
+ Please reference FreeRTOS Queue function prototypes. +``` +// Example implementation of FreeRTOS Queue +#define PlatformQueueHandle_t QueueHandle_t +#define PlatformQueue_Create xQueueCreate +#define PlatformQueue_Send xQueueSend +#define PlatformQueue_Receive xQueueReceive +#define PlatformQueue_Delete vQueueDelete ``` - Delay
The following API should be provided in cellular_platform.h.
Please reference FreeRTOS Task Control function prototypes. diff --git a/docs/doxygen/portingCellularModule.dox b/docs/doxygen/portingCellularModule.dox index 2c78322c..d345dd62 100644 --- a/docs/doxygen/portingCellularModule.dox +++ b/docs/doxygen/portingCellularModule.dox @@ -220,10 +220,12 @@ The URC callback function, @ref CellularAtParseTokenHandler_t, will be called wi @page cellular_prefix_string_customize_config Customization config for prefix string. @brief The config can be redefined in cellular_config.h to support different modem prefix string format.
-@section CELLULAR_CHECK_IS_PREFIX_CHAR +@section check_is_prefix_char_config +CELLULAR_CHECK_IS_PREFIX_CHAR @copydoc CELLULAR_CHECK_IS_PREFIX_CHAR -@section CELLULAR_CHECK_IS_PREFIX_LEADING_CHAR +@section check_is_prefix_leading_char_config +CELLULAR_CHECK_IS_PREFIX_LEADING_CHAR @copydoc CELLULAR_CHECK_IS_PREFIX_LEADING_CHAR */