diff --git a/lib/include/openamp/rpmsg.h b/lib/include/openamp/rpmsg.h index 9c2b347..f994e1d 100644 --- a/lib/include/openamp/rpmsg.h +++ b/lib/include/openamp/rpmsg.h @@ -161,8 +161,8 @@ struct rpmsg_device { * @brief Send a message across to the remote processor, * specifying source and destination address. * - * This function sends @data of length @len to the remote @dst address from - * the source @src address. + * This function sends `data` of length `len` to the remote `dst` address from + * the source `src` address. * The message will be sent to the remote processor which the channel belongs * to. * @@ -182,9 +182,9 @@ int rpmsg_send_offchannel_raw(struct rpmsg_endpoint *ept, uint32_t src, /** * @brief Send a message across to the remote processor * - * This function sends @data of length @len based on the @ept. + * This function sends `data` of length `len` based on the `ept`. * The message will be sent to the remote processor which the channel belongs - * to, using @ept's source and destination addresses. + * to, using `ept`'s source and destination addresses. * In case there are no TX buffers available, the function will block until * one becomes available, or a timeout of 15 seconds elapses. When the latter * happens, -ERESTARTSYS is returned. @@ -208,9 +208,9 @@ static inline int rpmsg_send(struct rpmsg_endpoint *ept, const void *data, /** * @brief Send a message across to the remote processor, specify dst * - * This function sends @data of length @len to the remote @dst address. - * The message will be sent to the remote processor which the @ept - * channel belongs to, using @ept's source address. + * This function sends `data` of length `len` to the remote `dst` address. + * The message will be sent to the remote processor which the `ept` + * channel belongs to, using `ept`'s source address. * In case there are no TX buffers available, the function will block until * one becomes available, or a timeout of 15 seconds elapses. When the latter * happens, -ERESTARTSYS is returned. @@ -234,9 +234,9 @@ static inline int rpmsg_sendto(struct rpmsg_endpoint *ept, const void *data, /** * @brief Send a message using explicit src/dst addresses * - * This function sends @data of length @len to the remote @dst address, - * and uses @src as the source address. - * The message will be sent to the remote processor which the @ept + * This function sends `data` of length `len` to the remote `dst` address, + * and uses `src` as the source address. + * The message will be sent to the remote processor which the `ept` * channel belongs to. * In case there are no TX buffers available, the function will block until * one becomes available, or a timeout of 15 seconds elapses. When the latter @@ -260,9 +260,9 @@ static inline int rpmsg_send_offchannel(struct rpmsg_endpoint *ept, /** * @brief Send a message across to the remote processor * - * This function sends @data of length @len on the @ept channel. - * The message will be sent to the remote processor which the @ept - * channel belongs to, using @ept's source and destination addresses. + * This function sends `data` of length `len` on the `ept` channel. + * The message will be sent to the remote processor which the `ept` + * channel belongs to, using `ept`'s source and destination addresses. * In case there are no TX buffers available, the function will immediately * return -ENOMEM without waiting until one becomes available. * @@ -285,9 +285,9 @@ static inline int rpmsg_trysend(struct rpmsg_endpoint *ept, const void *data, /** * @brief Send a message across to the remote processor, specify dst * - * This function sends @data of length @len to the remote @dst address. - * The message will be sent to the remote processor which the @ept - * channel belongs to, using @ept's source address. + * This function sends `data` of length `len` to the remote `dst` address. + * The message will be sent to the remote processor which the `ept` + * channel belongs to, using `ept`'s source address. * In case there are no TX buffers available, the function will immediately * return -ENOMEM without waiting until one becomes available. * @@ -310,9 +310,9 @@ static inline int rpmsg_trysendto(struct rpmsg_endpoint *ept, const void *data, /** * @brief Send a message using explicit src/dst addresses * - * This function sends @data of length @len to the remote @dst address, - * and uses @src as the source address. - * The message will be sent to the remote processor which the @ept + * This function sends `data` of length `len` to the remote `dst` address, + * and uses `src` as the source address. + * The message will be sent to the remote processor which the `ept` * channel belongs to. * In case there are no TX buffers available, the function will immediately * return -ENOMEM without waiting until one becomes available. diff --git a/lib/include/openamp/virtio.h b/lib/include/openamp/virtio.h index 6f88112..5f2f71d 100644 --- a/lib/include/openamp/virtio.h +++ b/lib/include/openamp/virtio.h @@ -236,11 +236,11 @@ struct virtio_dispatch { /** Get the feature exposed by the virtio device. */ uint32_t (*get_features)(struct virtio_device *dev); - /** Set the supported feature (virtio driver only). */ + /** Set the supported `feature` (virtio driver only). */ void (*set_features)(struct virtio_device *dev, uint32_t feature); /** - * Set the supported feature negotiate between the \ref features parameter and features + * Set the supported features negotiate between the `features` parameter and features * supported by the device (virtio driver only). */ uint32_t (*negotiate_features)(struct virtio_device *dev,