Fixed some doxygen warnings

[ahcorde]

Fixed some doxygen warnings

@ivanpauno and/or @hidmic do you mind to fix the rest of the doxygen warnings (as you are the main contributors of the repo) ?

src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/graph_cache.hpp:529: warning: Compound rmw_dds_common::EntityInfo is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/graph_cache.hpp:522: warning: Compound rmw_dds_common::ParticipantInfo is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/context.hpp:31: warning: Compound rmw_dds_common::Context is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/graph_cache.hpp:344: warning: Member DemangleFunctionT (typedef) of class rmw_dds_common::GraphCache is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/gid_utils.hpp:29: warning: Member operator()(const rmw_gid_t &lhs, const rmw_gid_t &rhs) const (function) of class rmw_dds_common::Compare_rmw_gid_t is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/context.hpp:32: warning: Member gid (variable) of class rmw_dds_common::Context is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/context.hpp:33: warning: Member pub (variable) of class rmw_dds_common::Context is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/context.hpp:34: warning: Member sub (variable) of class rmw_dds_common::Context is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/context.hpp:35: warning: Member graph_cache (variable) of class rmw_dds_common::Context is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/context.hpp:36: warning: Member node_update_mutex (variable) of class rmw_dds_common::Context is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/context.hpp:37: warning: Member listener_thread (variable) of class rmw_dds_common::Context is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/context.hpp:38: warning: Member thread_is_running (variable) of class rmw_dds_common::Context is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/context.hpp:39: warning: Member listener_thread_gc (variable) of class rmw_dds_common::Context is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/context.hpp:40: warning: Member graph_guard_condition (variable) of class rmw_dds_common::Context is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/graph_cache.hpp:539: warning: Member EntityInfo(const std::string &topic_name, const std::string &topic_type, const rmw_gid_t &participant_gid, const rmw_qos_profile_t &qos) (function) of class rmw_dds_common::EntityInfo is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/graph_cache.hpp:344: warning: Member DemangleFunctionT (typedef) of class rmw_dds_common::GraphCache is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/graph_cache.hpp:501: warning: Member NodeEntitiesInfoSeq (typedef) of class rmw_dds_common::GraphCache is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/graph_cache.hpp:503: warning: Member EntityGidToInfo (typedef) of class rmw_dds_common::GraphCache is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/graph_cache.hpp:504: warning: Member ParticipantToNodesMap (typedef) of class rmw_dds_common::GraphCache is not documented.
src/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/graph_cache.hpp:505: warning: Member GidSeq (typedef) of class rmw_dds_common::GraphCache is not documented.
Generating docs for compound rmw_dds_common::ParticipantInsrc/ros2/rmw_dds_common/rmw_dds_common/include/rmw_dds_common/graph_cache.hpp:523: warning: Member node_entities_info_seq (variable) of class rmw_dds_common::ParticipantInfo is not documented.

Signed-off-by: ahcorde ahcorde@gmail.com

[ivanpauno]

@ivanpauno and/or @hidmic do you mind to fix the rest of the doxygen warnings (as you are the main contributors of the repo) ?

will do

[ivanpauno]

@ahcorde I've fixed (almost) all the warnings.

There's still two related to the links between markdown files:

• README.md -> rmw_dds_common/QUALITY_DECLARATION.md
• rmw_dds_common/QUALITY_DECLARATION.md -> CONTRIBUTING.md

I don't know how to solve them. I guess you're experiencing the same problem in other repos, so you'll have to figure it out.

[ahcorde]

I found in the doxygen repo an issue with relative links https://github.com/doxygen/doxygen/issues/7595

We can skip for now these two issues

Thank you!

[ahcorde]

friendly ping @hidmic

[ivanpauno]

CI:

• Linux
• Linux-aarch64
• macOS
• Windows