Function header description consistency #478
Conversation
|
The purpose of this PR is to see a sample of the changes I am proposing for all the API function headers. |
Look good to go with this function header formatting. |
tammyleino
force-pushed
the
issue_477
branch
2 times, most recently
from
e74109c to
d8850d1
Compare
|
@arnopo Is there a way to override the failure of the checker not recognizing the word "doesn't"? |
you mean check the header syntax for doxygen? |
| * @param data Payload of the message | ||
| * @param len Length of the payload | ||
| * | ||
| * @return Number of bytes it has sent or negative error value on failure. | ||
| */ | ||
| static inline int rpmsg_send(struct rpmsg_endpoint *ept, const void *data, |
There was a problem hiding this comment.
seems that doxygen does not generate the documentation for static function. I don't know if there is a way to force it.... do you have a simple solution?
An alternative (which would get advantage to improve the support of RUST client) would be an implementation similar to
this proposal:
OpenAMP/libmetal@ef0a476
For this release we can just enter an issue to fix that later.
There was a problem hiding this comment.
@arnopo I think we should fix it according to the ticket you quote, but maybe not for this release since I foresee a lot of back and forth with that solution. I can set EXTRACT_STATIC to YES to resolve for Doxygen, and I will open a ticket for additional changes.
There was a problem hiding this comment.
Agree, Let treat "static" declaration issue in a next step and get this one for this release.
Updated function header descriptions formatting to be consistent. Signed-off-by: Tammy Leino <tammy.leino@siemens.com>
Set tabs to 8 spaces and enabled doc generation for static functions. Signed-off-by: Tammy Leino <tammy.leino@siemens.com>
Updated function header descriptions formatting to be consistent.
Signed-off-by: Tammy Leino tammy.leino@siemens.com