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 for the check and scope guard macros #1734

Merged
merged 3 commits into from Apr 1, 2019

Conversation

@sergeuz
Copy link
Member

commented Mar 26, 2019

Problem

This PR add Doxygen documentation for the CHECK() and SCOPE_GUARD() macros.

References

  • [ch26297]

Completeness

  • User is totes amazing for contributing!
  • Contributor has signed CLA (Info here)
  • Problem and Solution clearly stated
  • Run unit/integration/application tests on device
  • Added documentation
  • Added to CHANGELOG.md after merging (add links to docs and issues)

  • [Internal] Docs for the check and scope guard macros #1734

@sergeuz sergeuz requested review from technobly and zfields Mar 26, 2019

@zfields
Copy link
Contributor

left a comment

The documentation looks great! Super helpful!

I called out a couple knit picks about the wording (would love to have changed), but it's not worth blocking for.

services/inc/check.h Outdated Show resolved Hide resolved
services/inc/check.h Show resolved Hide resolved
services/inc/scope_guard.h Show resolved Hide resolved

@sergeuz sergeuz force-pushed the docs/helper_macros branch from a52d637 to 9e67984 Apr 1, 2019

@zfields
zfields approved these changes Apr 1, 2019

@sergeuz sergeuz merged commit 58b544f into develop Apr 1, 2019

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@sergeuz sergeuz deleted the docs/helper_macros branch Apr 1, 2019

@technobly technobly added this to the 1.1.0-rc.1 milestone Apr 1, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.