-
Notifications
You must be signed in to change notification settings - Fork 190
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
Update module documentation #1763
Merged
Merged
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
58ab8af
docs: Update GPIO docs
SergioGasquez 2d1c650
docs: Update other GPIO modules docs
SergioGasquez 451cef2
docs: Update AES mod documentation
SergioGasquez fdc4020
docs: Update Analog and ADC mod documentation
SergioGasquez 40334ee
docs: Update DAC mod documentation
SergioGasquez a232bae
docs: Update lib docs
SergioGasquez 1d02747
docs: Update clock mod documentation
SergioGasquez cc04aaa
docs: Update dma mod documentation
SergioGasquez 450b853
docs: Update interrupt mod documentation
SergioGasquez 93eb3ce
docs: Update lcd_cam mod documentation
SergioGasquez 2edf230
docs: Update ledc mod documentation
SergioGasquez 50abd34
docs: Update mcpwm mod documentation
SergioGasquez 86c845a
docs: Update pcnt mod documentation
SergioGasquez 634b452
docs: Update rom mod documentation
SergioGasquez beed589
docs: Update rsa mod documentation
SergioGasquez 4003dbe
docs: Update rtc_cntl mod documentation
SergioGasquez 5e87283
docs: Update spi mod documentation
SergioGasquez db7dc22
docs: Update timer mod documentation
SergioGasquez a16c620
docs: Update twai mod documentation
SergioGasquez 7182716
docs: Format headers
SergioGasquez 08a325b
style: Fix fmt
SergioGasquez ba57b42
refactor: Change visibility instead of hidding docs
SergioGasquez 269e962
style: Fix header
SergioGasquez 1984ece
Fix typo
SergioGasquez bf4526b
Fix typo
SergioGasquez b6c24b2
Fix typo
SergioGasquez 48b550b
Fix typo
SergioGasquez 7cd694e
Fix typo
SergioGasquez 41f2c20
docs: Add tracking issue
SergioGasquez b04ada1
docs: Remove architecture and simplify sentence
SergioGasquez 47c29e8
fix: Update visibilities remove hidden docs
SergioGasquez a368e50
Fix type
SergioGasquez cd66b10
docs: Improve wording
SergioGasquez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,20 @@ | ||
//! # Digital to Analog Converter (DAC) | ||
//! | ||
//! The `dac` module enables users to generate analog output signals with | ||
//! precise control over voltage levels using one of the onboard | ||
//! digital-to-analog converters (DAC). | ||
//! ## Overview | ||
//! Espressif devices usually have multiple DAC channels. Each DAC channel can | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as above? |
||
//! convert the digital value 0~255 to the analog voltage 0~Vref (The reference | ||
//! voltage 'Vref' here is input from an input pin) | ||
//! | ||
//! Two 8-bit DAC channels are available. Each DAC channel can convert the | ||
//! digital value 0-255 to the analog voltage 0-3.3v. Developers can choose the | ||
//! DAC channel they want to use based on the GPIO pin assignments for each | ||
//! channel. | ||
//! The DAC peripheral supports outputting analog signal in the multiple ways. | ||
//! | ||
//! ## Example | ||
//! Two 8-bit DAC channels are available. | ||
//! | ||
//! ## Configuration | ||
//! Developers can choose the DAC channel they want to use based on the GPIO | ||
//! pin assignments for each channel. | ||
//! | ||
//! ## Examples | ||
//! ### Write a value to a DAC channel | ||
//! ```rust, no_run | ||
#![doc = crate::before_snippet!()] | ||
//! # use esp_hal::gpio::Io; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can leave the Analog to Digital Converter here?