Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added doxyfiles #372

Merged
merged 4 commits into from
Apr 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions rmw_fastrtps_cpp/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# All settings not listed here will use the Doxygen default values.

PROJECT_NAME = "rmw_fastrtps_cpp"
PROJECT_NUMBER = master
PROJECT_BRIEF = "Implement the ROS middleware interface using eProsima FastRTPS static code generation in C++."

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_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/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"
30 changes: 30 additions & 0 deletions rmw_fastrtps_dynamic_cpp/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 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 dynamic code generation in C++."

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/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"
30 changes: 30 additions & 0 deletions rmw_fastrtps_shared_cpp/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 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."

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_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/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"