patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

doc: edac: Separate Optional and Mandatory APIs

Browse source 
Make documentation more readable by separating API with help of @name
instead of simple comment in the code.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
This commit is contained in:
Andrei Emeltchenko 2023-11-01 14:31:37 +02:00 committed by Carles Cufí
parent 44e4425ef7
commit 1f03bad7cb
1 changed files with 18 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
include/zephyr/drivers/edac.h
View file

@ -74,7 +74,12 @@ __subsystem struct edac_driver_api {
* INTERNAL_HIDDEN @endcond * INTERNAL_HIDDEN @endcond
*/ */
/* Optional interfaces */ /**
* @name Optional interfaces
* @{
*
* EDAC Optional Interfaces
*/
/** /**
* @brief Set injection parameter param1 * @brief Set injection parameter param1
@ -241,7 +246,14 @@ static inline int edac_inject_error_trigger(const struct device *dev)
return api->inject_error_trigger(dev); return api->inject_error_trigger(dev);
} }
/* Mandatory interfaces */ /** @} */ /* End of EDAC Optional Interfaces */
/**
* @name Mandatory interfaces
* @{
*
* EDAC Mandatory Interfaces
*/
/** /**
* @brief Get ECC Error Log * @brief Get ECC Error Log
@ -398,8 +410,9 @@ static inline int edac_notify_callback_set(const struct device *dev,
return api->notify_cb_set(dev, cb); return api->notify_cb_set(dev, cb);
} }
/**
* @} /** @} */ /* End of EDAC Mandatory Interfaces */
*/
/** @} */ /* End of EDAC API */
#endif /* ZEPHYR_INCLUDE_DRIVERS_EDAC_H_ */ #endif /* ZEPHYR_INCLUDE_DRIVERS_EDAC_H_ */