Skip to content

boards/*: make doxygen brief description consistent#8405

Merged
kaspar030 merged 1 commit intoRIOT-OS:masterfrom
aabadie:pr/boards_brief_description
Jan 24, 2018
Merged

boards/*: make doxygen brief description consistent#8405
kaspar030 merged 1 commit intoRIOT-OS:masterfrom
aabadie:pr/boards_brief_description

Conversation

@aabadie
Copy link
Copy Markdown
Contributor

@aabadie aabadie commented Jan 23, 2018

Contribution description

This PR makes all doxygen brief description of boards consistent. In fact, the brief statement is most of the time written in board.h but it refers to the board group name.

See http://doc.riot-os.org/group__boards.html
Some boards brief description is Support for <board> which is correct and others have Board specific files for the <board> which is a bit misleading.

Issues/PRs references

None

@aabadie aabadie added Area: doc Area: Documentation Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation Area: boards Area: Board ports labels Jan 23, 2018
@aabadie aabadie changed the title boards/arduino-mkrgsm1400: add initial support (without GSM) boards/*: make doxygen brief description consistent Jan 23, 2018
@aabadie aabadie added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jan 23, 2018
@aabadie
Copy link
Copy Markdown
Contributor Author

aabadie commented Jan 23, 2018

Sorry for the wrong PR title, I don't know what happened...

@aabadie aabadie requested a review from miri64 January 23, 2018 07:46
@kaspar030
Copy link
Copy Markdown
Contributor

kaspar030 commented Jan 23, 2018

Found some @brief with "." at the end, and just commited the changes. Hope you don't mind, and feel free to squash into your commits.

@aabadie aabadie force-pushed the pr/boards_brief_description branch from 71468a2 to b78c96f Compare January 24, 2018 07:31
@aabadie
Copy link
Copy Markdown
Contributor Author

aabadie commented Jan 24, 2018

Found some @brief with "." at the end, and just commited the changes

Thanks, I squashed them.

Copy link
Copy Markdown
Contributor

@kaspar030 kaspar030 left a comment

Choose a reason for hiding this comment

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

ACK

@kaspar030 kaspar030 merged commit 7b9b383 into RIOT-OS:master Jan 24, 2018
@aabadie aabadie deleted the pr/boards_brief_description branch June 8, 2018 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: boards Area: Board ports Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants