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

Improved doxygen #275

Merged
merged 6 commits into from
Oct 11, 2021
Merged

Improved doxygen #275

merged 6 commits into from
Oct 11, 2021

Conversation

ahcorde
Copy link
Contributor

@ahcorde ahcorde commented Aug 26, 2021

Signed-off-by: ahcorde ahcorde@gmail.com

🎉 New feature

Summary

Improved doxygen and added CI linter

Test it

In the build directory run:

make doc
bash <(curl -s https://raw.githubusercontent.com/ignitionrobotics/ign-cmake/ign-cmake2/tools/doc_check.sh)

Checklist

Note to maintainers: Remember to use Squash-Merge

Signed-off-by: ahcorde <ahcorde@gmail.com>
@github-actions github-actions bot added the 🏰 citadel Ignition Citadel label Aug 26, 2021
@ahcorde
Copy link
Contributor Author

ahcorde commented Aug 26, 2021

It requires a cmake2 release gazebosim/gz-cmake#183

@ahcorde ahcorde self-assigned this Aug 26, 2021
@ahcorde ahcorde added the needs upstream release Blocked by a release of an upstream library label Aug 26, 2021
Signed-off-by: ahcorde <ahcorde@gmail.com>
Signed-off-by: ahcorde <ahcorde@gmail.com>
@ahcorde ahcorde removed the needs upstream release Blocked by a release of an upstream library label Sep 14, 2021
@codecov
Copy link

codecov bot commented Sep 14, 2021

Codecov Report

Merging #275 (269471f) into ign-gui3 (242dd40) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##           ign-gui3     #275   +/-   ##
=========================================
  Coverage     66.46%   66.46%           
=========================================
  Files            25       25           
  Lines          2949     2949           
=========================================
  Hits           1960     1960           
  Misses          989      989           
Impacted Files Coverage Δ
include/ignition/gui/GuiEvents.hh 100.00% <ø> (ø)
include/ignition/gui/Plugin.hh 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 242dd40...269471f. Read the comment docs.

@ahcorde
Copy link
Contributor Author

ahcorde commented Sep 22, 2021

friendly ping @jennuine

Copy link
Contributor

@jennuine jennuine left a comment

Choose a reason for hiding this comment

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

Looks good, some minor comments.

.github/workflows/ci.yml Show resolved Hide resolved
include/ignition/gui/Application.hh Outdated Show resolved Hide resolved
tutorials/03_plugins.md Show resolved Hide resolved
Signed-off-by: ahcorde <ahcorde@gmail.com>
@chapulina chapulina merged commit 89febb7 into ign-gui3 Oct 11, 2021
@chapulina chapulina deleted the ahcorde/doxygen branch October 11, 2021 22:54
@osrf-triage
Copy link

This pull request has been mentioned on Gazebo Community. There might be relevant details there:

https://community.gazebosim.org/t/new-ignition-releases-2022-01-10/1228/1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants