Open
Description
The data structures are not documented consistently, and the way they are currently documented, the member description does not show up in the documentation. This proposal will follow the convention set forth by Zephyr.
Example:
before:
/**
* struct rpmsg_endpoint - binds a local rpmsg address to its user
* @name: name of the service supported
* @rdev: pointer to the rpmsg device
* @addr: local address of the endpoint
* @dest_addr: address of the default remote endpoint binded.
* @cb: user rx callback, return value of this callback is reserved
* for future use, for now, only allow RPMSG_SUCCESS as return value.
* @ns_unbind_cb: end point service unbind callback, called when remote
* ept is destroyed.
* @node: end point node.
* @priv: private data for the driver's use
*
* In essence, an rpmsg endpoint represents a listener on the rpmsg bus, as
* it binds an rpmsg address with an rx callback handler.
*/
struct rpmsg_endpoint {
char name[RPMSG_NAME_SIZE];
struct rpmsg_device *rdev;
uint32_t addr;
uint32_t dest_addr;
rpmsg_ept_cb cb;
rpmsg_ns_unbind_cb ns_unbind_cb;
struct metal_list node;
void *priv;
};
after:
/**
* @brief structure that binds a local rpmsg address to its user
*
* In essence, an rpmsg endpoint represents a listener on the rpmsg bus, as
* it binds an rpmsg address with an rx callback handler.
*/
struct rpmsg_endpoint {
]; /** Name of the service supported */
char name[RPMSG_NAME_SIZE
/** Pointer to the rpmsg device */
struct rpmsg_device *rdev;
/** Local address of the endpoint */
uint32_t addr;
/** Address of the default remote endpoint binded */
uint32_t dest_addr;
/** User rx callback, return value of this callback is reserved
* for future use, for now, only allow RPMSG_SUCCESS
* as return value
*/
rpmsg_ept_cb cb;
/** Endpoint service unbind
* callback, called when remote ept is destroyed
*/
rpmsg_ns_unbind_cb ns_unbind_cb;
/** Endpoint node */
struct metal_list node;
/** Private data for the driver's use */
void *priv;
};
Secondly, update Doxyfile to remove line number / file from description of data structures members