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

Pull request for adding Doxygen documentation #2

Merged
merged 10 commits into from
Nov 8, 2024

Conversation

fjrodl
Copy link

@fjrodl fjrodl commented Nov 5, 2024

SCOPE
Automated Documentation

Title
Add Doxyfile and GitHub Action for Automatic Documentation Generation

Description
This pull request introduces the Doxyfile to structure and generate project documentation using Doxygen. Additionally, it includes a GitHub Action that automatically compiles the documentation on every push or pull request to the main branch, ensuring that the documentation remains updated and readily accessible.

Pipeline
Status: ok.

Other Comments

  1. The action configured in this pull request is designed to be flexible and can be extended in the future to include additional steps, such as automatic deployment of the documentation to GitHub Pages or other platforms.
  2. Please, check the headers added #include "rclcpp/serialization.hpp" #include "rclcpp/create_generic_subscription.hpp", in Afferent and Efferent.

@fmrico
Copy link
Member

fmrico commented Nov 8, 2024

LGTM

Merging!!! 🚀

Thanks @fjrodl

@fmrico fmrico merged commit 9a3b074 into CoreSenseEU:rolling Nov 8, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants