Skip to content

drivers*: add drivers with saul support in the doxygen drivers_saul group#9337

Merged
jia200x merged 1 commit intoRIOT-OS:masterfrom
aabadie:pr/drivers/doc_saul
Aug 27, 2018
Merged

drivers*: add drivers with saul support in the doxygen drivers_saul group#9337
jia200x merged 1 commit intoRIOT-OS:masterfrom
aabadie:pr/drivers/doc_saul

Conversation

@aabadie
Copy link
Copy Markdown
Contributor

@aabadie aabadie commented Jun 13, 2018

Contribution description

This PR is a follow-up of #9328 that put a doxygen dependency of drivers with saul support to the drivers_saul group.
This way all drivers with SAUL support can be reached directly when browsing the SAUL module documentation.

Issues/PRs references

follow-up of #9328

@aabadie aabadie added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation State: waiting for other PR State: The PR requires another PR to be merged first Area: drivers Area: Device drivers Area: SAUL Area: Sensor/Actuator Uber Layer labels Jun 13, 2018
@aabadie aabadie requested a review from miri64 June 13, 2018 07:32
@jnohlgard
Copy link
Copy Markdown
Member

I like this idea!
When you use @ingroup twice the page is available from two places in the ToC? Nice feature

@aabadie aabadie force-pushed the pr/drivers/doc_saul branch from 380157e to 36906a5 Compare June 19, 2018 07:59
@aabadie aabadie added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR and removed State: waiting for other PR State: The PR requires another PR to be merged first labels Jun 19, 2018
@aabadie
Copy link
Copy Markdown
Contributor Author

aabadie commented Jun 19, 2018

Just in case, this PR has been rebased.

@aabadie aabadie requested a review from jia200x August 27, 2018 08:29
@aabadie aabadie force-pushed the pr/drivers/doc_saul branch from 36906a5 to b22e7d0 Compare August 27, 2018 08:49
* @ingroup drivers_sensors
* @brief Device driver for the LSM6DSL 3D accelerometer/gyroscope
* @ingroup drivers_saul
* @brief Device drive for the LSM6DSL 3D accelerometer/gyroscope
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

s/drive/driver

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed and directly squashed

@jia200x
Copy link
Copy Markdown
Member

jia200x commented Aug 27, 2018

looks good. There's only a minor issue I just posted

@aabadie aabadie force-pushed the pr/drivers/doc_saul branch from b22e7d0 to 9f8386c Compare August 27, 2018 09:32
Copy link
Copy Markdown
Member

@jia200x jia200x left a comment

Choose a reason for hiding this comment

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

All good. ACK & GO

@jia200x jia200x merged commit 349af36 into RIOT-OS:master Aug 27, 2018
@aabadie aabadie deleted the pr/drivers/doc_saul branch September 23, 2018 08:44
@aabadie aabadie added this to the Release 2018.10 milestone Nov 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation Area: drivers Area: Device drivers Area: SAUL Area: Sensor/Actuator Uber Layer CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants