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

fix: comments for doxygen #287

Merged
merged 5 commits into from
Jun 18, 2024
Merged

fix: comments for doxygen #287

merged 5 commits into from
Jun 18, 2024

Conversation

xygyo77
Copy link
Contributor

@xygyo77 xygyo77 commented May 31, 2024

Description

Unify the description of doxygen comments for methods of the same family declared in tracing_controller.hpp.

Related links

https://tier4.atlassian.net/browse/RT2-1524

Notes for reviewers

Pre-review checklist for the PR author

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

  • The PR has been properly tested.
  • The PR has been reviewed.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.
  • The PR is ready for merge.

After all checkboxes are checked, anyone who has write access can merge the PR.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.18%. Comparing base (75e1c3f) to head (f87c3ed).
Report is 17 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #287       +/-   ##
===========================================
+ Coverage   25.02%   55.18%   +30.16%     
===========================================
  Files          58       28       -30     
  Lines        3321     2180     -1141     
  Branches     1085     1214      +129     
===========================================
+ Hits          831     1203      +372     
+ Misses       1756      697     -1059     
+ Partials      734      280      -454     
Flag Coverage Δ
differential 55.18% <ø> (?)
total ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@xygyo77 xygyo77 requested a review from ymski May 31, 2024 09:56
@xygyo77 xygyo77 changed the title fix comments for doxygen fix: comments for doxygen May 31, 2024
miyakoshi-dev
miyakoshi-dev previously approved these changes Jun 12, 2024
Copy link
Contributor

@miyakoshi-dev miyakoshi-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@ymski ymski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@xygyo77 xygyo77 merged commit 927ef26 into tier4:main Jun 18, 2024
14 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.

4 participants