Skip to content

Commit

Permalink
Add doxygen comments for Job Doc struct.
Browse files Browse the repository at this point in the history
  • Loading branch information
bradleysmith23 committed Nov 10, 2023
1 parent f41bccd commit 8ef2e93
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 29 deletions.
16 changes: 0 additions & 16 deletions docs/doxygen/config.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -2236,22 +2236,6 @@ GENERATE_AUTOGEN_DEF = NO

GENERATE_SQLITE3 = NO

# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
# in front of it.
# The default directory is: sqlite3.
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.

SQLITE3_OUTPUT = sqlite3

# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db
# database file will be recreated with each doxygen run. If set to NO, doxygen
# will warn if an a database file is already found and not modify it.
# The default value is: YES.
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.

SQLITE3_RECREATE_DB = YES

#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
Expand Down
26 changes: 13 additions & 13 deletions source/otaJobParser/include/job_parser.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@
*/
typedef struct
{
const char * signature;
size_t signatureLen;
const char * filepath;
size_t filepathLen;
const char * certfile;
size_t certfileLen;
const char * authScheme;
size_t authSchemeLen;
const char * imageRef;
size_t imageRefLen;
uint32_t fileId;
uint32_t fileSize;
uint32_t fileType;
const char * signature; /**< Code Signing Signature */
size_t signatureLen; /**< Length of signature */
const char * filepath; /**< File path to store OTA Update on device */
size_t filepathLen; /**< Length of filepath */
const char * certfile; /**< Path to Code Signing Certificate on Device */
size_t certfileLen; /**< Length of certfile */
const char * authScheme; /**< Authentication Scheme for HTTP URL ( null for MQTT )*/
size_t authSchemeLen; /**< Length of authScheme */
const char * imageRef; /**< MQTT Stream or HTTP URL */
size_t imageRefLen; /**< Length of imageRef */
uint32_t fileId; /**< File ID */
uint32_t fileSize; /**< Size of the OTA Update */
uint32_t fileType; /**< FIle Type */
} AfrOtaJobDocumentFields_t;

/**
Expand Down

0 comments on commit 8ef2e93

Please sign in to comment.