From 10aa44df7ab04f03435e07aa5f6637bee96691e8 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Thu, 23 Apr 2020 16:32:17 +0200 Subject: [PATCH 1/3] Added doxyfiles Signed-off-by: ahcorde --- rmw_fastrtps_cpp/Doxyfile | 35 +++++++++++++++++++++++++++++++ rmw_fastrtps_dynamic_cpp/Doxyfile | 31 +++++++++++++++++++++++++++ rmw_fastrtps_shared_cpp/Doxyfile | 32 ++++++++++++++++++++++++++++ 3 files changed, 98 insertions(+) create mode 100644 rmw_fastrtps_cpp/Doxyfile create mode 100644 rmw_fastrtps_dynamic_cpp/Doxyfile create mode 100644 rmw_fastrtps_shared_cpp/Doxyfile diff --git a/rmw_fastrtps_cpp/Doxyfile b/rmw_fastrtps_cpp/Doxyfile new file mode 100644 index 000000000..ca47fb9bc --- /dev/null +++ b/rmw_fastrtps_cpp/Doxyfile @@ -0,0 +1,35 @@ +# All settings not listed here will use the Doxygen default values. + +PROJECT_NAME = "rmw_fastrtps_cpp" +PROJECT_NUMBER = master +PROJECT_BRIEF = "Package containing tools for dynamically loadable components" + +# Use these lines to include the generated logging.hpp (update install path if needed) +# Otherwise just generate for the local (non-generated header files) + + +INPUT = ./include + +RECURSIVE = YES +OUTPUT_DIRECTORY = doc_output + +EXTRACT_ALL = YES +SORT_MEMBER_DOCS = NO + +GENERATE_LATEX = NO + +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +PREDEFINED = RCLCPP_PUBLIC= + +# Tag files that do not exist will produce a warning and cross-project linking will not work. +TAGFILES += "../../../../doxygen_tag_files/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/" +# Consider changing "latest" to the version you want to reference (e.g. beta1 or 1.0.0) +TAGFILES += "../../../../doxygen_tag_files/rclcpp.tag=http://docs.ros2.org//api/rclcpp/" +TAGFILES += "../../../../doxygen_tag_files/rcl_lifecycle.tag=http://docs.ros2.org//api/rcl_lifecycle/" +TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org//api/rcl/" +TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org//api/rmw/" +TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org//api/rcutils/" +# Uncomment to generate tag files for cross-project linking. +GENERATE_TAGFILE = "../../../../doxygen_tag_files/rmw_fastrtps_cpp.tag" diff --git a/rmw_fastrtps_dynamic_cpp/Doxyfile b/rmw_fastrtps_dynamic_cpp/Doxyfile new file mode 100644 index 000000000..9e941e444 --- /dev/null +++ b/rmw_fastrtps_dynamic_cpp/Doxyfile @@ -0,0 +1,31 @@ +# All settings not listed here will use the Doxygen default values. + +PROJECT_NAME = "rmw_fastrtps_dynamic_cpp" +PROJECT_NUMBER = master +PROJECT_BRIEF = "Implement the ROS middleware interface using eProsima FastRTPS static code generation in C++." + +# Use these lines to include the generated logging.hpp (update install path if needed) +# Otherwise just generate for the local (non-generated header files) +INPUT = ./include + +RECURSIVE = YES +OUTPUT_DIRECTORY = doc_output + +EXTRACT_ALL = YES +SORT_MEMBER_DOCS = NO + +GENERATE_LATEX = NO + +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +PREDEFINED = RMW_FASTRTPS_DYNAMIC_CPP_PUBLIC= + +# Tag files that do not exist will produce a warning and cross-project linking will not work. +TAGFILES += "../../../../doxygen_tag_files/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/" +# Consider changing "latest" to the version you want to reference (e.g. beta1 or 1.0.0) +TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org//api/rcl/" +TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org//api/rmw/" +TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org//api/rcutils/" +# Uncomment to generate tag files for cross-project linking. +GENERATE_TAGFILE = "../../../../doxygen_tag_files/rmw_fastrtps_dynamic_cpp.tag" diff --git a/rmw_fastrtps_shared_cpp/Doxyfile b/rmw_fastrtps_shared_cpp/Doxyfile new file mode 100644 index 000000000..e8b4bef01 --- /dev/null +++ b/rmw_fastrtps_shared_cpp/Doxyfile @@ -0,0 +1,32 @@ +# All settings not listed here will use the Doxygen default values. + +PROJECT_NAME = "rmw_fastrtps_shared_cpp" +PROJECT_NUMBER = master +PROJECT_BRIEF = "Code shared on static and dynamic type support of rmw_fastrtps_cpp." + +# Use these lines to include the generated logging.hpp (update install path if needed) +# Otherwise just generate for the local (non-generated header files) +INPUT = ./include + +RECURSIVE = YES +OUTPUT_DIRECTORY = doc_output + +EXTRACT_ALL = YES +SORT_MEMBER_DOCS = NO + +GENERATE_LATEX = NO + +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +PREDEFINED = RMW_FASTRTPS_DYNAMIC_CPP_PUBLIC= + +# Tag files that do not exist will produce a warning and cross-project linking will not work. +TAGFILES += "../../../../doxygen_tag_files/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/" +# Consider changing "latest" to the version you want to reference (e.g. beta1 or 1.0.0) +TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org//api/rcl/" +TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org//api/rmw/" +TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org//api/rcutils/" +TAGFILES += "../../../../doxygen_tag_files/rcpputils.tag=http://docs.ros2.org//api/rcpputils/" +# Uncomment to generate tag files for cross-project linking. +GENERATE_TAGFILE = "../../../../doxygen_tag_files/rmw_fastrtps_shared_cpp.tag" From e7e66d8881f7873a9311d5473fc11947d6c815d1 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Tue, 28 Apr 2020 10:53:08 +0200 Subject: [PATCH 2/3] Added feedback Signed-off-by: ahcorde --- rmw_fastrtps_cpp/Doxyfile | 14 +++++++------- rmw_fastrtps_dynamic_cpp/Doxyfile | 9 +++++---- rmw_fastrtps_shared_cpp/Doxyfile | 10 +++++----- 3 files changed, 17 insertions(+), 16 deletions(-) diff --git a/rmw_fastrtps_cpp/Doxyfile b/rmw_fastrtps_cpp/Doxyfile index ca47fb9bc..7e0ed3dda 100644 --- a/rmw_fastrtps_cpp/Doxyfile +++ b/rmw_fastrtps_cpp/Doxyfile @@ -2,7 +2,7 @@ PROJECT_NAME = "rmw_fastrtps_cpp" PROJECT_NUMBER = master -PROJECT_BRIEF = "Package containing tools for dynamically loadable components" +PROJECT_BRIEF = "Implement the ROS middleware interface using eProsima FastRTPS static code generation in C++." # Use these lines to include the generated logging.hpp (update install path if needed) # Otherwise just generate for the local (non-generated header files) @@ -21,15 +21,15 @@ GENERATE_LATEX = NO ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES -PREDEFINED = RCLCPP_PUBLIC= +PREDEFINED = RMW_FASTRTPS_CPP_PUBLIC= # Tag files that do not exist will produce a warning and cross-project linking will not work. TAGFILES += "../../../../doxygen_tag_files/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/" # Consider changing "latest" to the version you want to reference (e.g. beta1 or 1.0.0) -TAGFILES += "../../../../doxygen_tag_files/rclcpp.tag=http://docs.ros2.org//api/rclcpp/" -TAGFILES += "../../../../doxygen_tag_files/rcl_lifecycle.tag=http://docs.ros2.org//api/rcl_lifecycle/" -TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org//api/rcl/" -TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org//api/rmw/" -TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org//api/rcutils/" +TAGFILES += "../../../../doxygen_tag_files/rclcpp.tag=http://docs.ros2.org/latest/api/rclcpp/" +TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org/latest/api/rcl/" +TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org/latest/api/rmw/" +TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org/latest/api/rcutils/" +TAGFILES += "../../../../doxygen_tag_files/rmw_fastrtps_shared_cpp.tag=http://docs.ros2.org/latest/api/rmw_fastrtps_shared_cpp/" # Uncomment to generate tag files for cross-project linking. GENERATE_TAGFILE = "../../../../doxygen_tag_files/rmw_fastrtps_cpp.tag" diff --git a/rmw_fastrtps_dynamic_cpp/Doxyfile b/rmw_fastrtps_dynamic_cpp/Doxyfile index 9e941e444..f7bee66ce 100644 --- a/rmw_fastrtps_dynamic_cpp/Doxyfile +++ b/rmw_fastrtps_dynamic_cpp/Doxyfile @@ -2,7 +2,7 @@ PROJECT_NAME = "rmw_fastrtps_dynamic_cpp" PROJECT_NUMBER = master -PROJECT_BRIEF = "Implement the ROS middleware interface using eProsima FastRTPS static code generation in C++." +PROJECT_BRIEF = "Implement the ROS middleware interface using eProsima FastRTPS dynamic code generation in C++." # Use these lines to include the generated logging.hpp (update install path if needed) # Otherwise just generate for the local (non-generated header files) @@ -24,8 +24,9 @@ PREDEFINED = RMW_FASTRTPS_DYNAMIC_CPP_PUBLIC= # Tag files that do not exist will produce a warning and cross-project linking will not work. TAGFILES += "../../../../doxygen_tag_files/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/" # Consider changing "latest" to the version you want to reference (e.g. beta1 or 1.0.0) -TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org//api/rcl/" -TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org//api/rmw/" -TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org//api/rcutils/" +TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org/latest/api/rcl/" +TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org/latest/api/rmw/" +TAGFILES += "../../../../doxygen_tag_files/rmw_fastrtps_shared_cpp.tag=http://docs.ros2.org/latest/api/rmw_fastrtps_shared_cpp/" +TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org/latest/api/rcutils/" # Uncomment to generate tag files for cross-project linking. GENERATE_TAGFILE = "../../../../doxygen_tag_files/rmw_fastrtps_dynamic_cpp.tag" diff --git a/rmw_fastrtps_shared_cpp/Doxyfile b/rmw_fastrtps_shared_cpp/Doxyfile index e8b4bef01..0acf59b56 100644 --- a/rmw_fastrtps_shared_cpp/Doxyfile +++ b/rmw_fastrtps_shared_cpp/Doxyfile @@ -19,14 +19,14 @@ GENERATE_LATEX = NO ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES -PREDEFINED = RMW_FASTRTPS_DYNAMIC_CPP_PUBLIC= +PREDEFINED = RMW_FASTRTPS_SHARED_CPP_PUBLIC= # Tag files that do not exist will produce a warning and cross-project linking will not work. TAGFILES += "../../../../doxygen_tag_files/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/" # Consider changing "latest" to the version you want to reference (e.g. beta1 or 1.0.0) -TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org//api/rcl/" -TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org//api/rmw/" -TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org//api/rcutils/" -TAGFILES += "../../../../doxygen_tag_files/rcpputils.tag=http://docs.ros2.org//api/rcpputils/" +TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org/latest/api/rcl/" +TAGFILES += "../../../../doxygen_tag_files/rmw.tag=http://docs.ros2.org/latest/api/rmw/" +TAGFILES += "../../../../doxygen_tag_files/rcutils.tag=http://docs.ros2.org/latest/api/rcutils/" +TAGFILES += "../../../../doxygen_tag_files/rcpputils.tag=http://docs.ros2.org/latest/api/rcpputils/" # Uncomment to generate tag files for cross-project linking. GENERATE_TAGFILE = "../../../../doxygen_tag_files/rmw_fastrtps_shared_cpp.tag" From 1f7761e2cf2a0f9117bf0c81b6ad9ea80cb1c0b8 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Wed, 29 Apr 2020 09:02:09 +0200 Subject: [PATCH 3/3] Removed comments Signed-off-by: ahcorde --- rmw_fastrtps_cpp/Doxyfile | 4 ---- rmw_fastrtps_dynamic_cpp/Doxyfile | 2 -- rmw_fastrtps_shared_cpp/Doxyfile | 2 -- 3 files changed, 8 deletions(-) diff --git a/rmw_fastrtps_cpp/Doxyfile b/rmw_fastrtps_cpp/Doxyfile index 7e0ed3dda..d805cf7df 100644 --- a/rmw_fastrtps_cpp/Doxyfile +++ b/rmw_fastrtps_cpp/Doxyfile @@ -4,10 +4,6 @@ PROJECT_NAME = "rmw_fastrtps_cpp" PROJECT_NUMBER = master PROJECT_BRIEF = "Implement the ROS middleware interface using eProsima FastRTPS static code generation in C++." -# Use these lines to include the generated logging.hpp (update install path if needed) -# Otherwise just generate for the local (non-generated header files) - - INPUT = ./include RECURSIVE = YES diff --git a/rmw_fastrtps_dynamic_cpp/Doxyfile b/rmw_fastrtps_dynamic_cpp/Doxyfile index f7bee66ce..5d6a2fe9e 100644 --- a/rmw_fastrtps_dynamic_cpp/Doxyfile +++ b/rmw_fastrtps_dynamic_cpp/Doxyfile @@ -4,8 +4,6 @@ PROJECT_NAME = "rmw_fastrtps_dynamic_cpp" PROJECT_NUMBER = master PROJECT_BRIEF = "Implement the ROS middleware interface using eProsima FastRTPS dynamic code generation in C++." -# Use these lines to include the generated logging.hpp (update install path if needed) -# Otherwise just generate for the local (non-generated header files) INPUT = ./include RECURSIVE = YES diff --git a/rmw_fastrtps_shared_cpp/Doxyfile b/rmw_fastrtps_shared_cpp/Doxyfile index 0acf59b56..6bab21f1f 100644 --- a/rmw_fastrtps_shared_cpp/Doxyfile +++ b/rmw_fastrtps_shared_cpp/Doxyfile @@ -4,8 +4,6 @@ PROJECT_NAME = "rmw_fastrtps_shared_cpp" PROJECT_NUMBER = master PROJECT_BRIEF = "Code shared on static and dynamic type support of rmw_fastrtps_cpp." -# Use these lines to include the generated logging.hpp (update install path if needed) -# Otherwise just generate for the local (non-generated header files) INPUT = ./include RECURSIVE = YES