diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dfa8cc2e..1b5b9afc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -101,4 +101,4 @@ jobs: uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main with: config: .github/memory_statistics_config.json - check_against: docs/doxygen/include/size_table.html + check_against: docs/doxygen/include/size_table.md diff --git a/.github/workflows/memory_statistics.yml b/.github/workflows/memory_statistics.yml index 499d205b..9c778c76 100644 --- a/.github/workflows/memory_statistics.yml +++ b/.github/workflows/memory_statistics.yml @@ -19,4 +19,4 @@ jobs: uses: actions/upload-artifact@v2 with: name: size_table - path: size_table.html + path: size_table.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d1ff96e..83f0d7b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,10 @@ # Changelog for AWS IoT Device Shadow library -## v1.1.1 (May 2021) + +## v1.1.1 (July 2021) ### Other - [#85](https://github.com/aws/Device-Shadow-for-AWS-IoT-embedded-sdk/pull/85) Fix CBMC proof for `Shadow_AssembleTopicString` API. + - [#88](https://github.com/aws/Device-Shadow-for-AWS-IoT-embedded-sdk/pull/88) Update broken MISRA link ## v1.1.0 (March 2021) diff --git a/README.md b/README.md index 2640e586..e756d531 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,20 @@ Please refer to the demos of the AWS IoT Device Shadow library in the following | FreeRTOS | [FreeRTOS/FreeRTOS](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS-Plus/Demo/AWS/Device_Shadow_Windows_Simulator) | FreeRTOS+TCP for TCP/IP and mbedTLS for TLS stack | | FreeRTOS | [FreeRTOS AWS Reference Integrations](https://github.com/aws/amazon-freertos/tree/master/demos/device_shadow_for_aws) | Based on Secure Sockets Abstraction | +## Documentation + +### Existing Documentation + +For pre-generated documentation, please see the documentation linked in the locations below: + +| Location | +| :-: | +| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) | +| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/device-shadow-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html) | + +Note that the latest included version of IoT Device Shadow library may differ across repositories. + + ## Generating documentation The Doxygen references were created using Doxygen version 1.8.20. To generate the diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile index 6d0ac502..1833aa38 100644 --- a/docs/doxygen/config.doxyfile +++ b/docs/doxygen/config.doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = "AWS IoT Device Shadow" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = "v1.1.0" +PROJECT_NUMBER = "v1.1.1" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/docs/doxygen/include/size_table.html b/docs/doxygen/include/size_table.md similarity index 100% rename from docs/doxygen/include/size_table.html rename to docs/doxygen/include/size_table.md diff --git a/docs/doxygen/pages.dox b/docs/doxygen/pages.dox index 49173063..99cf0dd3 100644 --- a/docs/doxygen/pages.dox +++ b/docs/doxygen/pages.dox @@ -15,7 +15,7 @@ Embedded devices often use MQTT to interact with Device Shadow. This library pro @section shadow_memory_requirements Memory Requirements @brief Memory requirements of the Shadow library. -@include{doc} size_table.html +@include{doc} size_table.md */ /** diff --git a/lexicon.txt b/lexicon.txt index a5440012..291fa4c3 100644 --- a/lexicon.txt +++ b/lexicon.txt @@ -15,10 +15,10 @@ css defgroup developerguide device-shadow-limits +doxygen endcode endif endlink -doxygen gcc generatedtopicstringlength getshadowoperationlength @@ -44,6 +44,7 @@ mainpage malloc matchtopic maxallowedlength +md mdash messagetype mqtt @@ -59,10 +60,10 @@ outlength param pconsumedtopiclength pmessagetype -png -posix pname pnamelength +png +posix poutlength pre pshadowname @@ -85,12 +86,12 @@ shadowtopicstringtypedeleterejected shadowtopicstringtypeget shadowtopicstringtypegetaccepted shadowtopicstringtypegetrejected +shadowtopicstringtypemaxnum shadowtopicstringtypeupdate shadowtopicstringtypeupdateaccepted shadowtopicstringtypeupdatedelta shadowtopicstringtypeupdatedocuments shadowtopicstringtypeupdaterejected -shadowtopicstringtypemaxnum sizeof stdint stringlength @@ -110,5 +111,5 @@ topiclength topicnamelength topictype tr -utest un +utest diff --git a/manifest.yml b/manifest.yml index a4fde9ac..bffa437b 100644 --- a/manifest.yml +++ b/manifest.yml @@ -1,5 +1,5 @@ name : "Device-Shadow-for-AWS-IoT-embedded-sdk" -version: "v1.1.0" +version: "v1.1.1" description: | "Client library for using the AWS IoT Device Shadow service on embedded devices.\n" license: "MIT" diff --git a/source/include/shadow.h b/source/include/shadow.h index 52239cc4..fd015737 100644 --- a/source/include/shadow.h +++ b/source/include/shadow.h @@ -1,6 +1,6 @@ /* - * AWS IoT Device Shadow v1.1.0 - * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * AWS IoT Device Shadow v1.1.1 + * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy of * this software and associated documentation files (the "Software"), to deal in diff --git a/source/include/shadow_config_defaults.h b/source/include/shadow_config_defaults.h index f3378f7e..3d34a1b4 100644 --- a/source/include/shadow_config_defaults.h +++ b/source/include/shadow_config_defaults.h @@ -1,6 +1,6 @@ /* - * AWS IoT Device Shadow v1.1.0 - * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * AWS IoT Device Shadow v1.1.1 + * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy of * this software and associated documentation files (the "Software"), to deal in