Mirrors_Framework/open-amp
1
0
Fork 0
mirror of https://github.com/OpenAMP/open-amp.git synced 2026-09-23 16:44:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

lib: fix doxygen warning: "Found unknown command"

Browse Source 
The doxygen build report issue for function descriptions that provide
reference to some function parameters using @:

...
lib/include/openamp/rpmsg.h:160: warning: Found unknown command '\data'
lib/include/openamp/rpmsg.h:160: warning: Found unknown command '\len'
...

Fix the warning by replacing with back-ticks that will be interpreted as
code by Markdown(Markdown support is enabled in the Doxygen configuration).

Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
This commit is contained in:
Arnaud Pouliquen
2024-05-16 09:05:29 +02:00
committed by Arnaud Pouliquen
parent 304c34606e
commit 7257deaab3
2 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/include/openamp/rpmsg.h
+19 -19
View File
@@ -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.
lib/include/openamp/virtio.h
+2 -2
View File
@@ -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,