Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make formatting issues #77

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,15 @@ library. This library is distributed under the

This library has gone through code quality checks including verification that no
function has a

[GNU Complexity](https://www.gnu.org/software/complexity/manual/complexity.html)
score over 8, and checks against deviations from mandatory rules in the
[MISRA coding standard](https://www.misra.org.uk). Deviations from the MISRA
C:2012 guidelines are documented under [MISRA Deviations](MISRA.md). This
library has also undergone static code analysis using
[Coverity static analysis](https://scan.coverity.com/), and validation of memory
safety through the

[CBMC automated reasoning tool](https://www.cprover.org/cbmc/).

See memory requirements for this library
Expand Down
8 changes: 4 additions & 4 deletions source/defender.c
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
/**
* @brief Get the topic length for a given defender API.
*
* @param[in] thingNameLength The length of the thing name as registered with AWS IoT.
* @param[in] thingNameLength The length of the thing name as registered with AWS IoT.
* @param[in] api The defender API value.
*
* @return The topic length for the given defender API.
Expand All @@ -48,19 +48,19 @@ static uint16_t getTopicLength( uint16_t thingNameLength,
DefenderTopic_t api );

/**
* @brief Write the format and suffix part for the given defender API to the buffer.
* @brief Write the format and suffix part for the given defender API to the buffer.
*
* Format: json or cbor.
* Suffix: /accepted or /rejected or empty.
*
* @param[in] pBuffer The buffer to write the format and suffix part into.
* @param[in] pBuffer The buffer to write the format and suffix part into.
* @param[in] api The defender API value.
*
* @note This function assumes that the buffer is large enough to hold the
* value.
*/
static void writeFormatAndSuffix( char * pBuffer,
DefenderTopic_t api );
DefenderTopic_t api );

/**
* @brief Check if the unparsed topic so far starts with the defender prefix.
Expand Down
Loading