Skip to content

Commit 062bad1

Browse files
authored
Add memory table to doxygen (#48)
1 parent 377808f commit 062bad1

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/doxygen/config.doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,7 @@ EXCLUDE_SYMBOLS =
923923
# that contain example code fragments that are included (see the \include
924924
# command).
925925

926-
EXAMPLE_PATH = source/include
926+
EXAMPLE_PATH = source/include docs/doxygen/include
927927

928928
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
929929
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and

docs/doxygen/pages.dox

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ The coreMQTT Agent is a thread-safe library to serialize calls to coreMQTT, to b
88
@section coreMQTT_brief Why is there a higher level library based on coreMQTT?
99
coreMQTT is an MIT licensed open source C MQTT client library for microcontroller and small microprocessor based IoT devices. Its design is intentionally simple to ensure it has no dependency on any other library or operating system, and to better enable static analysis including memory safety proofs. That simplicity and lack of operating system dependency (coreMQTT does not require multithreading at all) means coreMQTT does not build thread safety directly into its implementation. Instead, thread safety must be provided by higher level software. The coreMQTT Agent library is a coreMQTT extension that provides that higher level functionality in the form of an MQTT agent (or MQTT daemon).
1010

11+
@section core_mqtt_agent_memory_requirements Memory Requirements
12+
@brief Memory requirements of the MQTT Agent library, including the coreMQTT library.
13+
14+
@include{doc} size_table.html
1115
*/
1216

1317
/**

0 commit comments

Comments
 (0)