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

docs: fixed missing/incorrect params for many functions #1110

Merged
merged 1 commit into from
Mar 28, 2024

Conversation

Jaskowicz1
Copy link
Contributor

This PR fixes many missing/incorrect params for some functions.

This PR also adds the message_edit_flags coro and sync calls, as they were missing from the last PR.

Code change checklist

  • I have ensured that all methods and functions are fully documented using doxygen style comments.
  • My code follows the coding style guide.
  • I tested that my change works before raising the PR.
  • I have ensured that I did not break any existing API calls.
  • I have not built my pull request using AI, a static analysis tool or similar without any human oversight.

@Jaskowicz1 Jaskowicz1 self-assigned this Mar 28, 2024
Copy link

netlify bot commented Mar 28, 2024

Deploy Preview for dpp-dev ready!

Name Link
🔨 Latest commit 2a785e5
🔍 Latest deploy log https://app.netlify.com/sites/dpp-dev/deploys/6605644eb8c5370008e59653
😎 Deploy Preview https://deploy-preview-1110--dpp-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added documentation Improvements or additions to documentation code Improvements or additions to code. labels Mar 28, 2024
@Jaskowicz1
Copy link
Contributor Author

Jaskowicz1 commented Mar 28, 2024

It's worth noting that there are still a couple of issues left, however, these are not things that are missing but rather doxygen struggling to understand a couple things. These are:

/mnt/c/Users/archi/Desktop/DPP/include/dpp/event_router.h:714: warning: unable to resolve reference to 'operator(F&&)' for \ref command
/mnt/c/Users/archi/Desktop/DPP/include/dpp/coro/coroutine.h:439: warning: argument 'expr' from the argument list of dpp::detail::coroutine::promise_t::return_value has multiple @param documentation sections
/mnt/c/Users/archi/Desktop/DPP/include/dpp/event_router.h:145: warning: unexpected token in comment block while parsing the argument of command throw
/mnt/c/Users/archi/Desktop/DPP/include/dpp/event_router.h:140: warning: documented empty return type of dpp::detail::event_router::awaitable::await_suspend
/mnt/c/Users/archi/Desktop/DPP/include/dpp/coro/task.h:626: warning: unable to resolve reference to 'proxy_awaiter' for \ref command
/mnt/c/Users/archi/Desktop/DPP/include/dpp/coro/task.h:662: warning: argument 'expr' from the argument list of dpp::detail::task::promise_t::return_value has multiple @param documentation sections
/mnt/c/Users/archi/Desktop/DPP/include/dpp/coro/task.h:626: warning: unable to resolve reference to 'proxy_awaiter' for \ref command

@Jaskowicz1 Jaskowicz1 merged commit 44bfb17 into brainboxdotcc:dev Mar 28, 2024
44 checks passed
@Jaskowicz1 Jaskowicz1 deleted the documentation-additions branch March 28, 2024 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code Improvements or additions to code. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants