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.

Sign up for GitHub

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

Jump to bottom

drivers/cc110x: Fixed documentaion #12177

Merged
merged 2 commits into from
Sep 6, 2019
Merged

drivers/cc110x: Fixed documentaion #12177

merged 2 commits into from
Sep 6, 2019

Conversation

maribu
Copy link
Member

@maribu maribu commented Sep 6, 2019

Contribution description

  • Fixed unbalanced Doxygen "open doc group" (@{) and "close doc group" (@}) commands
  • Added missing documentation the current release of Doxygen complains about

Testing procedure

Run make doc with the current doxygen release. There should be no warnings related to drivers/cc110x anymore. (Be prepared to receive a lot of warnings unrelated to this PR.)

Issues/PRs references

None

@maribu
drivers/cc110x: Fixed broken Doxygen grouping
b389a9c 
The header files of the CC110x contained two Doxygen "end of doc group" (@})
commands. This PR makes sure they are balanced again.
@maribu
drivers/cc110x: Added missing Doxygen comments
84acc74 
The current stable Doxygen release should no longer complain now
@maribu maribu added Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) Area: doc Area: Documentation Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Area: drivers Area: Device drivers CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Sep 6, 2019
benpicco
benpicco approved these changes Sep 6, 2019
View reviewed changes
Copy link
Contributor

@benpicco benpicco left a comment

Choose a reason for hiding this comment

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

Only documentation changes and doccheck is happy.

@benpicco benpicco merged commit 0ba4c87 into RIOT-OS:master Sep 6, 2019
@maribu
Copy link
Member Author

maribu commented Sep 6, 2019

Thank you very much for the review! :-)

@maribu maribu deleted the cc110x-doc branch September 6, 2019 19:38
@kb2ma kb2ma added this to the Release 2019.10 milestone Sep 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benpicco benpicco benpicco approved these changes

Assignees
No one assigned
Labels
Area: doc Area: Documentation Area: drivers Area: Device drivers CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)
Projects
None yet
Milestone
Release 2019.10
Development

Successfully merging this pull request may close these issues.
3 participants
@maribu @benpicco @kb2ma