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

Add Doxyfile #1589

Open
wants to merge 1 commit into
base: rolling
Choose a base branch
from
Open
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
20 changes: 20 additions & 0 deletions rosbag2_compression/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# All settings not listed here will use the Doxygen default values.

PROJECT_NAME = "rosbag2_compression"
PROJECT_NUMBER = rolling
PROJECT_BRIEF = "Compression implementations for rosbag2 bags and messages"

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 = ROSBAG2_TRANSPORT_PUBLIC=
20 changes: 20 additions & 0 deletions rosbag2_compression_zstd/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# All settings not listed here will use the Doxygen default values.

PROJECT_NAME = "rosbag2_compression_zstd"
PROJECT_NUMBER = rolling
PROJECT_BRIEF = "Zstandard compression library implementation of rosbag2_compression"

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 = ROSBAG2_TRANSPORT_PUBLIC=
20 changes: 20 additions & 0 deletions rosbag2_cpp/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# All settings not listed here will use the Doxygen default values.

PROJECT_NAME = "rosbag2_cpp"
PROJECT_NUMBER = rolling
PROJECT_BRIEF = "C++ ROSBag2 client library"

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 = ROSBAG2_TRANSPORT_PUBLIC=
20 changes: 20 additions & 0 deletions rosbag2_storage/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# All settings not listed here will use the Doxygen default values.

PROJECT_NAME = "rosbag2_storage"
PROJECT_NUMBER = rolling
PROJECT_BRIEF = "ROS2 independent storage format to store serialized ROS2 messages"

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 = ROSBAG2_TRANSPORT_PUBLIC=
20 changes: 20 additions & 0 deletions rosbag2_storage_mcap/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# All settings not listed here will use the Doxygen default values.

PROJECT_NAME = "rosbag2_storage_mcap"
PROJECT_NUMBER = rolling
PROJECT_BRIEF = "rosbag2 storage plugin using the MCAP file format"

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 = ROSBAG2_TRANSPORT_PUBLIC=
20 changes: 20 additions & 0 deletions rosbag2_storage_sqlite3/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# All settings not listed here will use the Doxygen default values.

PROJECT_NAME = "rosbag2_storage_sqlite3"
PROJECT_NUMBER = rolling
PROJECT_BRIEF = "ROSBag2 SQLite3 storage plugin"

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 = ROSBAG2_TRANSPORT_PUBLIC=
20 changes: 20 additions & 0 deletions rosbag2_transport/Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# All settings not listed here will use the Doxygen default values.

PROJECT_NAME = "rosbag2_transport"
PROJECT_NUMBER = rolling
PROJECT_BRIEF = "Layer encapsulating ROS middleware to allow rosbag2 to be used with or without middleware"

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 = ROSBAG2_TRANSPORT_PUBLIC=
Loading