From 65451f2fe334631b77003d0c0dc49cd3eaa00ef8 Mon Sep 17 00:00:00 2001 From: SarenaAWS <6563840+sarenameas@users.noreply.github.com> Date: Wed, 16 Sep 2020 12:19:20 -0700 Subject: [PATCH] Update the doxygen template to match current library repos. (#1273) * Update the doxygen template to match current library repos. * Add .dox to the FILE_PATTERNS for the template. * Take out
because the configs looks better without and coreMQTT is not using. --- docs/doxygen_templates/config.doxyfile | 2 +- docs/doxygen_templates/pages.dox | 12 +++++------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/doxygen_templates/config.doxyfile b/docs/doxygen_templates/config.doxyfile index bf8140c9de..7ad628430a 100644 --- a/docs/doxygen_templates/config.doxyfile +++ b/docs/doxygen_templates/config.doxyfile @@ -874,7 +874,7 @@ INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.c \ *.h \ - *.txt + *.dox # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. diff --git a/docs/doxygen_templates/pages.dox b/docs/doxygen_templates/pages.dox index 4849f86706..a8861e7da5 100644 --- a/docs/doxygen_templates/pages.dox +++ b/docs/doxygen_templates/pages.dox @@ -8,14 +8,13 @@ @section []_memory_requirements Memory Requirements @brief Memory requirements of the [] library. -The configurations for memory estimation are defined here. - - + + @@ -23,11 +22,13 @@ The configurations for memory estimation are defined ]_config.h) or by using a compiler option such as -D in gcc. @section [] -
@copydoc [] @section [] -
@copydoc [] @section [] -
@copydoc [] */ @@ -93,7 +91,7 @@ Configuration settings are C pre-processor constants. They can be set with a \#d /** @defgroup []_struct_types Parameter Structures -@brief Structures passed as parameters to [<[FIXME: Library name>] library functions](@ref []_functions) +@brief Structures passed as parameters to [[] library functions](@ref []_functions) These structures are passed as parameters to library functions. Documentation for these structures will state the functions associated with each parameter structure and the purpose of each member. */
Code Size of [](example generated with GCC for ARM Cortex-M)
Code size of [] library files (sizes generated with [GCC for ARM Cortex-M toolchain 20191025](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads/9-2019-q4-major))
FileNo Optimization (asserts enabled) With -O1 Optimisation With -Os Optimisation