Fix up documentation build for rmw when using rosdoc2#313
Conversation
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
|
Full CI!
Argh, build issues in |
|
Alright, it wasn't just Re-running full CI:
|
Is there a way to make doxygen ignore that instead of renaming *_t to *_s. |
I followed ros2/rcutils#333 precedent here, but perhaps /// \cond flag
typedef
/// \endcond
struct type_name_t {
}
/// \cond flag
type_name_t
/// \endcond
;Though I do find duplicate type definitions awkward albeit legal.
Well, I've found some cases. Specially in |
That seems to be enough precedent, we will have to bump the major number next release. |
Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>
clalancette
left a comment
There was a problem hiding this comment.
This all looks really good to me with green CI.
Thanks for iterating!
| rmw_topic_endpoint_info_set_gid( | ||
| rmw_topic_endpoint_info_t * topic_endpoint_info, | ||
| const uint8_t gid[], | ||
| const uint8_t * gid, |
There was a problem hiding this comment.
Why this change? (just curious)
There was a problem hiding this comment.
WARNING: doxygenfunction: Unable to resolve function "rmw_topic_endpoint_info_set_gid" with arguments (rmw_topic_endpoint_info_t*, const uint8_t, size_t) in doxygen xml output for project "rmw Doxygen Project" from directory: ...
Potential matches:
- rmw_ret_t rmw_topic_endpoint_info_set_gid(rmw_topic_endpoint_info_t *topic_endpoint_info, const uint8_t gid[], size_t size)
It appears exhale (i.e. the thing that turns Doxygen XML into Sphinx compliant ReST) fails to pick up a trailing [] as a type modifier. I haven't dug into it deep enough to find out why.
|
|
||
| /// Define publisher/subscription events | ||
| typedef enum rmw_event_type_t | ||
| typedef enum rmw_event_type_e |
There was a problem hiding this comment.
Will this break rmw implementations?
There was a problem hiding this comment.
Any RMW implementation that was using a "bare" rmw_event_type_t before should be fine; we are still defining that as part of the typedef. If an RMW implementation was using enum rmw_event_type_t, then it would now be broken.
I don't think we have any users of that in the core, but I will request a full CI run before we merge this. There might be third-party ones that use enum rmw_event_type_t, so I think a release note is in order for this change.
|
Re-running full CI:
|
|
Alright, all green ! |
|
This pull request has been mentioned on ROS Discourse. There might be relevant details there: https://discourse.ros.org/t/ros-2-tsc-meeting-minutes-2021-9-16/22372/1 |
Precisely what the title says. This patch:
[]tokens for leading*tokens for pointer argument types.RCUTILS_DEPRECATED_WITH_MSG()macrosRMW_PUBLIC_TYPEmacros.