diff options
author | Chris Kay <chris.kay@arm.com> | 2020-09-28 12:38:49 +0100 |
---|---|---|
committer | jimqui01 <54316584+jimqui01@users.noreply.github.com> | 2020-10-02 14:19:09 +0100 |
commit | 691839e0c23cd6b836a39029e0639b9f62d6b46a (patch) | |
tree | 63c4f0de7b1d57a9c6f7417f7bff807019087a3d /product/morello | |
parent | 3361c3269a4c6b053a39766c945a8be1611ce5c7 (diff) |
docs: Normalize Doxygen paragraph indentation
Doxygen continutation line intendation across the code-base is currently
inconsistent in spite of the code-style documentation specifying a
two-tab indent on continuation lines.
Change-Id: I0944d749042972797bde1997f02afd98d4028c1a
Signed-off-by: Chris Kay <chris.kay@arm.com>
Diffstat (limited to 'product/morello')
4 files changed, 24 insertions, 25 deletions
diff --git a/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h b/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h index 94960b84..b33145ac 100644 --- a/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h +++ b/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h @@ -148,8 +148,8 @@ struct mod_cmn_skeena_config { /*! * \brief HN-F with CAL support flag * \details When set to true, enables HN-F with CAL support. This flag will - * be used only if HN-F is found to be connected to CAL (When connected to - * a CAL port, node id of HN-F will be a odd number). + * be used only if HN-F is found to be connected to CAL (When connected + * to a CAL port, node id of HN-F will be a odd number). */ bool hnf_cal_mode; }; diff --git a/product/morello/module/dmc_bing/include/mod_dmc_bing.h b/product/morello/module/dmc_bing/include/mod_dmc_bing.h index 75e7d3d2..6e8a4e78 100644 --- a/product/morello/module/dmc_bing/include/mod_dmc_bing.h +++ b/product/morello/module/dmc_bing/include/mod_dmc_bing.h @@ -29,8 +29,7 @@ * Technical Reference Manual for details on the specific registers that * are programmed here. * - * \sa - * https://developer.arm.com/docs/100568/latest/programmers-model/register-summary + * \sa https://developer.arm.com/docs/100568/latest/programmers-model/register-summary * \{ */ diff --git a/product/morello/module/morello_smt/include/mod_smt.h b/product/morello/module/morello_smt/include/mod_smt.h index 6b012eb9..27d062c1 100644 --- a/product/morello/module/morello_smt/include/mod_smt.h +++ b/product/morello/module/morello_smt/include/mod_smt.h @@ -18,7 +18,7 @@ * \name Channel policies * * \details These policies define attributes that affect how the channel is - * treated by the SMT component. + * treated by the SMT component. * * \{ */ @@ -107,7 +107,7 @@ struct mod_smt_driver_api { * \retval ::FWK_SUCCESS The operation succeeded * \retval ::FWK_E_PARAM The device_id parameter is invalid * \return One of the standard error codes for implementation-defined - * errors + * errors */ int (*raise_interrupt)(fwk_id_t device_id); }; @@ -125,7 +125,7 @@ struct mod_smt_driver_input_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*signal_message)(fwk_id_t channel_id); }; @@ -139,13 +139,13 @@ struct mod_scmi_to_transport_api { * * \param channel_id Channel identifier. * \param[out] secure The channel security state. True - * if the channel is secure, or false if it is non-secure. + * if the channel is secure, or false if it is non-secure. * * \retval ::FWK_SUCCESS The operation succeeded. * \retval ::FWK_E_PARAM The channel_id parameter is invalid. * \retval ::FWK_E_PARAM The secure parameter is NULL. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_secure)(fwk_id_t channel_id, bool *secure); @@ -159,7 +159,7 @@ struct mod_scmi_to_transport_api { * \retval ::FWK_E_PARAM The channel_id parameter is invalid. * \retval ::FWK_E_PARAM The size parameter is NULL. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_max_payload_size)(fwk_id_t channel_id, size_t *size); @@ -174,7 +174,7 @@ struct mod_scmi_to_transport_api { * \retval ::FWK_E_PARAM The message_header parameter is NULL. * \retval ::FWK_E_ACCESS No message is available to read. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_message_header)(fwk_id_t channel_id, uint32_t *message_header); @@ -184,14 +184,14 @@ struct mod_scmi_to_transport_api { * \param channel_id Channel identifier. * \param[out] payload The pointer to the payload. * \param[out] size The payload size. May be NULL, in which case the - * parameter should be ignored. + * parameter should be ignored. * * \retval ::FWK_SUCCESS The operation succeeded. * \retval ::FWK_E_PARAM The channel_id parameter is invalid. * \retval ::FWK_E_PARAM The payload parameter is NULL. * \retval ::FWK_E_ACCESS No message is available to read. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_payload)(fwk_id_t channel_id, const void **payload, size_t *size); @@ -206,9 +206,9 @@ struct mod_scmi_to_transport_api { * \retval ::FWK_SUCCESS The operation succeeded. * \retval ::FWK_E_PARAM The payload parameter is NULL. * \retval ::FWK_E_PARAM The offset and size provided are not within the - * bounds of the payload area. + * bounds of the payload area. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*write_payload)( fwk_id_t channel_id, @@ -221,16 +221,16 @@ struct mod_scmi_to_transport_api { * * \param channel_id Channel identifier. * \param payload Payload data to write, or NULL if a payload has already - * been written. + * been written. * \param size Size of the payload source. * * \retval ::FWK_SUCCESS The operation succeeded. * \retval ::FWK_E_PARAM The channel_id parameter is invalid. * \retval ::FWK_E_PARAM The size parameter is less than the size of one - * payload entry. + * payload entry. * \retval ::FWK_E_ACCESS No message is available to respond to. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*respond)(fwk_id_t channel_id, const void *payload, size_t size); }; @@ -259,7 +259,7 @@ struct mod_scmi_agent_to_transport_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*send)(fwk_id_t channel_id, struct mod_smt_command_config *cmd); @@ -269,11 +269,11 @@ struct mod_scmi_agent_to_transport_api { * \param channel_id Channel identifier. * \param[out] payload The pointer to the payload. * \param[out] size The payload size. May be NULL, in which case the - * parameter should be ignored. + * parameter should be ignored. * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_payload)(fwk_id_t channel_id, const void **payload, size_t *size); @@ -284,7 +284,7 @@ struct mod_scmi_agent_to_transport_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*put_channel)(fwk_id_t channel_id); }; diff --git a/product/morello/module/scmi_agent/include/mod_scmi_agent.h b/product/morello/module/scmi_agent/include/mod_scmi_agent.h index 5ca4acee..b5873798 100644 --- a/product/morello/module/scmi_agent/include/mod_scmi_agent.h +++ b/product/morello/module/scmi_agent/include/mod_scmi_agent.h @@ -79,7 +79,7 @@ struct mod_scmi_agent_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_protocol_version)(fwk_id_t agent_id, uint32_t *version); @@ -91,7 +91,7 @@ struct mod_scmi_agent_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_clock_status)(fwk_id_t agent_id, uint32_t *clock_status); @@ -104,7 +104,7 @@ struct mod_scmi_agent_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_chipid_info)( fwk_id_t agent_id, |