Skip to content

Commit

Permalink
Update the doxygen template to match current library repos. (#1273)
Browse files Browse the repository at this point in the history
* Update the doxygen template to match current library repos.

* Add .dox to the FILE_PATTERNS for the template.

* Take out <br> because the configs looks better without and coreMQTT is not using.
  • Loading branch information
sarenameas authored Sep 16, 2020
1 parent ab23215 commit 65451f2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/doxygen_templates/config.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 5 additions & 7 deletions docs/doxygen_templates/pages.dox
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,27 @@
@section [<FIXME: Lowercase library name>]_memory_requirements Memory Requirements
@brief Memory requirements of the [<FIXME: Library name>] library.

The configurations for memory estimation are defined <a href="https://github.com/FreeRTOS/FreeRTOS/tree/lts-development/tools/memory_estimator" target="_blank" rel="noopener noreferrer">here</a>.

<table>
<tr>
<td colspan="3"><b>Code Size of [<FIXME: Library name and version>](example generated with GCC for ARM Cortex-M)</b></td>
<td colspan="4"><center><b>Code size of [<FIXME: Library name>] 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))</b></center></td>
</tr>
<tr>
<td><b>File</b></td>
<td><b>No Optimization (asserts enabled)</b></td>
<td><b>With -O1 Optimisation</b></td>
<td><b>With -Os Optimisation</b></td>
</tr>
<tr>
<td>[<FIXME: library source, add more rows for more source>]</td>
<td>[<FIXME: Code size>]</td>
<td>[<FIXME: Code size>]</td>
<td>[<FIXME: Code size>]</td>
</tr>
<tr>
<td><b>Total estimates</b></td>
<td>[<FIXME: Total code size>]</td>
<td>[<FIXME: Total code size>]</td>
<td>[<FIXME: Total code size>]</td>
</tr>
</table>
*/
Expand All @@ -48,15 +49,12 @@ The configurations for memory estimation are defined <a href="https://github.com
Configuration settings are C pre-processor constants. They can be set with a \#define in the config file ([<FIXME: Lowercase library name>]_config.h) or by using a compiler option such as -D in gcc.

@section [<FIXME: Library compile time configuration macro>]
<br>
@copydoc [<FIXME: Library compile time configuration macro>]

@section [<FIXME: Library compile time configuration macro>]
<br>
@copydoc [<FIXME: Library compile time configuration macro>]

@section [<FIXME: Library compile time configuration macro>]
<br>
@copydoc [<FIXME: Library compile time configuration macro>]
*/

Expand Down Expand Up @@ -93,7 +91,7 @@ Configuration settings are C pre-processor constants. They can be set with a \#d

/**
@defgroup [<FIXME: Lowercase library name>]_struct_types Parameter Structures
@brief Structures passed as parameters to [<[FIXME: Library name>] library functions](@ref [<FIXME: Lowercase library name>]_functions)
@brief Structures passed as parameters to [[<FIXME: Library name>] library functions](@ref [<FIXME: Lowercase library name>]_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.
*/
Expand Down

0 comments on commit 65451f2

Please sign in to comment.