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

Cleanup doxygen doc #42

Merged
merged 11 commits into from
Jun 18, 2024
Merged

Cleanup doxygen doc #42

merged 11 commits into from
Jun 18, 2024

Conversation

hiergaut
Copy link
Contributor

@hiergaut hiergaut commented Apr 15, 2024

Pull Request Desription

Check if you branch history is PR compatible

  • Your branch need to be up to date with origin/main
  • Update your git repository git fetch origin if origin is this remote
  • Check format style with the script provided in scripts/source-format-all.sh
  • You must use clang-format style (github CI version is 11)
  • Your proposal must include a commit where the file CHANGELOG is updated (add a line describing the proposed change + PR id, see file for examples). If your contribution is significant, you can also ask to be added to the contributor list in the discussion.
    These checks are enforced by github workflow actions
    Please refer to the corresponding log in case of failure

UPDATE the form below to describe your PR

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines (see CONTRIBUTING)
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Be aware that the PR request cannot be accepted if it doesn't pass the Continuous Integration tests.

  • What kind of change does this PR introduce?

    • bug fix
    • feature
    • docs update
    • other:
  • What is the current behavior? (You can also link to an open issue here)
    Doxygen has empty comments.

  • What is the new behavior (if this is a feature change)?
    Doxygen has useful comments.

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

  • Other information:
    Only documentation performed.

@hiergaut hiergaut requested a review from nmellado April 22, 2024 13:31
@hiergaut
Copy link
Contributor Author

Ready for review.

@hiergaut hiergaut mentioned this pull request Apr 22, 2024
Copy link
Contributor

@nmellado nmellado left a comment

Choose a reason for hiding this comment

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

Nice. Maybe we wait for Sphinx first ?

@hiergaut
Copy link
Contributor Author

I don't know, conflicts guaranteed in both cases, so waiting for #26.

@hiergaut
Copy link
Contributor Author

Some commits have to be squashed.

@hiergaut hiergaut added the TOPULL #3 Pull request to be done thirdly label May 7, 2024
@nmellado nmellado added TOPULL #2 Pull request to be done secondly and removed TOPULL #3 Pull request to be done thirdly labels May 14, 2024
@hiergaut hiergaut added TOPULL Pull request to be done firstly and removed TOPULL #2 Pull request to be done secondly labels May 16, 2024
@hiergaut
Copy link
Contributor Author

Ready for the merge.

@hiergaut hiergaut mentioned this pull request May 16, 2024
7 tasks
@nmellado
Copy link
Contributor

@hiergaut this branch has conflicts and cannot be rebased, can you have a look please ?

@hiergaut
Copy link
Contributor Author

Sure

@hiergaut hiergaut force-pushed the cleanupDoxygenDoc branch 2 times, most recently from 38bd098 to e7659c3 Compare May 21, 2024 16:54
@hiergaut
Copy link
Contributor Author

@nmellado done

@nmellado nmellado merged commit 0093dd6 into main Jun 18, 2024
6 checks passed
@nmellado nmellado deleted the cleanupDoxygenDoc branch June 18, 2024 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
TOPULL Pull request to be done firstly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants