Skip to content

Commit 0dbd23f

Browse files
sarenameasleegeth
andauthored
Delete irrelevant comment about memory estimation. (#28)
* Delete irrelevant comment about memory estimation. * Update the name of the shadow library. * Update config.doxyfile Co-authored-by: leegeth <[email protected]>
1 parent c9e39b8 commit 0dbd23f

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

docs/doxygen/config.doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My Project.
3434

35-
PROJECT_NAME = "Shadow"
35+
PROJECT_NAME = "AWS IoT Device Shadow"
3636

3737
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3838
# could be handy for archiving the generated documentation or if some version
@@ -44,7 +44,7 @@ PROJECT_NUMBER = "v1.0.0"
4444
# for a project that appears at the top of each page and should give viewer a
4545
# quick idea about the purpose of the project. Keep the description short.
4646

47-
PROJECT_BRIEF = "Shadow library"
47+
PROJECT_BRIEF = "AWS IoT Device Shadow client library"
4848

4949
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
5050
# in the documentation. The maximum height of the logo should not exceed 55

docs/doxygen/pages.dox

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
@mainpage Overview
33
@anchor shadow
4-
@brief Shadow library
4+
@brief AWS IoT Device Shadow library
55

66
> A device's shadow is a JSON document that is used to store and retrieve current state information for a device. The Device Shadow service maintains a shadow for each device you connect to AWS IoT. You can use the shadow to get and set the state of a device over MQTT or HTTP, regardless of whether the device is connected to the Internet. Each device's shadow is uniquely identified by the name of the corresponding thing.
77
<span style="float:right;margin-right:4em"> &mdash; <i>Description of Device Shadow from AWS IoT documentation [https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html)</i></span><br>
@@ -15,8 +15,6 @@ Embedded devices often use MQTT to interact with Device Shadow. This library pro
1515
@section shadow_memory_requirements Memory Requirements
1616
@brief Memory requirements of the Shadow library.
1717

18-
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>.
19-
2018
<table>
2119
<tr>
2220
<td colspan="4"><center><b>Code Size of Device Shadow Library (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>

0 commit comments

Comments
 (0)