diff --git a/docs/doxygen/pages.dox b/docs/doxygen/pages.dox index dc14788..d115429 100644 --- a/docs/doxygen/pages.dox +++ b/docs/doxygen/pages.dox @@ -145,3 +145,8 @@ These configuration settings are C pre-processor constants they are set using a @defgroup jobs_constants Constants @brief Constants defined in the Jobs library */ + +/** +@defgroup jobs_structs Structs +@brief Structs defined in the Jobs Library +*/ diff --git a/source/otaJobParser/include/job_parser.h b/source/otaJobParser/include/job_parser.h index c08b973..3671799 100644 --- a/source/otaJobParser/include/job_parser.h +++ b/source/otaJobParser/include/job_parser.h @@ -15,23 +15,24 @@ #include /** + * @ingroup jobs_structs * @brief struct containing the fields of an AFR OTA Job Document */ typedef struct { - 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 */ + const char * signature; /**< @brief Code Signing Signature */ + size_t signatureLen; /**< @brief Length of signature */ + const char * filepath; /**< @brief File path to store OTA Update on device */ + size_t filepathLen; /**< @brief Length of filepath */ + const char * certfile; /**< @brief Path to Code Signing Certificate on Device */ + size_t certfileLen; /**< @brief Length of certfile */ + const char * authScheme; /**< @brief Authentication Scheme for HTTP URL ( null for MQTT )*/ + size_t authSchemeLen; /**< @brief Length of authScheme */ + const char * imageRef; /**< @brief MQTT Stream or HTTP URL */ + size_t imageRefLen; /**< @brief Length of imageRef */ + uint32_t fileId; /**< @brief File ID */ + uint32_t fileSize; /**< @brief Size of the OTA Update */ + uint32_t fileType; /**< @brief FIle Type */ } AfrOtaJobDocumentFields_t; /**