doc: edac: Separate Optional and Mandatory APIs
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:
parent
44e4425ef7
commit
1f03bad7cb
|
@ -74,7 +74,12 @@ __subsystem struct edac_driver_api {
|
|||
* INTERNAL_HIDDEN @endcond
|
||||
*/
|
||||
|
||||
/* Optional interfaces */
|
||||
/**
|
||||
* @name Optional interfaces
|
||||
* @{
|
||||
*
|
||||
* EDAC Optional Interfaces
|
||||
*/
|
||||
|
||||
/**
|
||||
* @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);
|
||||
}
|
||||
|
||||
/* Mandatory interfaces */
|
||||
/** @} */ /* End of EDAC Optional Interfaces */
|
||||
|
||||
/**
|
||||
* @name Mandatory interfaces
|
||||
* @{
|
||||
*
|
||||
* EDAC Mandatory Interfaces
|
||||
*/
|
||||
|
||||
/**
|
||||
* @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);
|
||||
}
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
/** @} */ /* End of EDAC Mandatory Interfaces */
|
||||
|
||||
/** @} */ /* End of EDAC API */
|
||||
|
||||
#endif /* ZEPHYR_INCLUDE_DRIVERS_EDAC_H_ */
|
||||
|
|
Loading…
Reference in a new issue