Branch: refs/heads/main Home: https://github.com/OpenAMP/open-amp Commit: 304c34606e5990364e0f9b983fd0cd6f476c4739 https://github.com/OpenAMP/open-amp/commit/304c34606e5990364e0f9b983fd0cd6f4... Author: Arnaud Pouliquen arnaud.pouliquen@foss.st.com Date: 2024-05-16 (Thu, 16 May 2024)
Changed paths: M lib/include/openamp/remoteproc.h M lib/include/openamp/rpmsg_rpc_client_server.h M lib/include/openamp/virtio.h M lib/include/openamp/virtio_mmio.h M lib/rpmsg/rpmsg_internal.h M lib/rpmsg/rpmsg_virtio.c
Log Message: ----------- lib: fix doxygen miscellaneous warnings
Remove warning reported by Doxygen on doc generation: - rewrite enum documentation, - replace @ by \ref for references, - fix param names
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Commit: 7257deaab3491543261dfc8b084f6f332f2ef57f https://github.com/OpenAMP/open-amp/commit/7257deaab3491543261dfc8b084f6f332... Author: Arnaud Pouliquen arnaud.pouliquen@foss.st.com Date: 2024-05-16 (Thu, 16 May 2024)
Changed paths: M lib/include/openamp/rpmsg.h M lib/include/openamp/virtio.h
Log Message: ----------- lib: fix doxygen warning: "Found unknown command"
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
Compare: https://github.com/OpenAMP/open-amp/compare/2e5026fd7d46...7257deaab349
To unsubscribe from these emails, change your notification settings at https://github.com/OpenAMP/open-amp/settings/notifications