Doxygen updates for data structures #507
Conversation
|
This is a first commit, which updates formatting of the already fully documented data structures. There are still 30 data structures that need to be updated that are not currently documented but show up in the documentation as public data structures as documented here #506. Hopefully we can split that work up among multiple people once a consistent format is established. |
lib/include/openamp/remoteproc.h
Outdated
| * @size: size of the memory | ||
| * @io: pointer to the I/O region | ||
| * @node: list node | ||
| * @brief Memory used by the remote processor |
There was a problem hiding this comment.
/** @brief Memory used by the remote processor */
Somes other occurrences in you PR
There was a problem hiding this comment.
Do you think we should elaborate more on this description? I don't really like things to have just a brief - it would be nice to have additional information.
There was a problem hiding this comment.
Yes would be nice, just need to find the good threshold to not over comment.
I would say it depends on whether it is easy or not to understand the structure without extra description.
There was a problem hiding this comment.
@arnopo I'm just going to leave things as-is for this PR. We can decide if things need more detail in a future revision.
tammyleino
force-pushed
the
issue506
branch
2 times, most recently
from
1bbf2a7 to
fd79127
Compare
|
@arnopo I have addressed your outstanding comments with the latest version of the PR. |
lib/include/openamp/rpmsg_virtio.h
Outdated
|
|
||
| /** | ||
| * RPMsg buffer reclaimer that contains buffers released by the | ||
| * rpmsg_virtio_release_tx_buffer function |
There was a problem hiding this comment.
is the link to rpmsg_virtio_release_tx_buffer is generated?
There was a problem hiding this comment.
No, but I have updated it so it will. Thanks!
lib/include/openamp/remoteproc.h
Outdated
| * @size: size of the memory | ||
| * @io: pointer to the I/O region | ||
| * @node: list node | ||
| * @brief Memory used by the remote processor |
There was a problem hiding this comment.
Yes would be nice, just need to find the good threshold to not over comment.
I would say it depends on whether it is easy or not to understand the structure without extra description.
lib/rpmsg/rpmsg_internal.h
Outdated
| char name[RPMSG_NAME_SIZE]; | ||
|
|
||
| /** Address of the remote service that is being published */ |
There was a problem hiding this comment.
We can replace "address" with "endpoint number"
There was a problem hiding this comment.
I would prefer endpoint address as it represent the address of the endpoint for RP message delivery.
Improved doxygen formatting and consistency for data structures. Signed-off-by: Tammy Leino <[email protected]>
Improved doxygen formatting and consistency for data structures.
Signed-off-by: Tammy Leino [email protected]