OpenAMP / open-amp

The main OpenAMP library implementing RPMSG, Virtio, and Remoteproc for RTOS etc
https://www.openampproject.org/
Other
678 stars 278 forks source link

Doxygen updates for data structures #507

Closed tammyleino closed 9 months ago

tammyleino commented 9 months ago

Improved doxygen formatting and consistency for data structures. Signed-off-by: Tammy Leino tammy.leino@siemens.com

tammyleino commented 9 months ago

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 https://github.com/OpenAMP/open-amp/issues/506. Hopefully we can split that work up among multiple people once a consistent format is established.

tammyleino commented 9 months ago

@arnopo I have addressed your outstanding comments with the latest version of the PR.