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] Timer API documentation #6335

Merged
merged 1 commit into from
Feb 23, 2022
Merged

Conversation

P-R-O-C-H-Y
Copy link
Member

Summary

Documentation for Timer peripheral.
Edited one function input in esp32-hal-timer.h to match the .c file.

Impact

Related links

@P-R-O-C-H-Y P-R-O-C-H-Y added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Feb 23, 2022
@P-R-O-C-H-Y P-R-O-C-H-Y self-assigned this Feb 23, 2022
@me-no-dev me-no-dev merged commit a57cac6 into espressif:master Feb 23, 2022
Comment on lines +35 to +37
* ``resolution`` select timer resolution.

* range is 1-14 bits (1-20 bits for ESP32).
Copy link
Contributor

Choose a reason for hiding this comment

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

Uhhm, no...the 3rd parameter is a bool called countUp.

Copy link
Member

Choose a reason for hiding this comment

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

Thank you for the feedback, @marcelstoer.
I'll create an issue and fix the docs.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks @pedrominatel for taking care of it. Sorry for the mistake.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants