3 Commits

Author	SHA1	Message	Date
Kirill Mikhailov	2bd10526a7	Documenting a number of peripherals and packages (#680) ... * Initial documentation improvements * More documentation improvements * More documentation improvements More modules documented * Finished SOC documentation for esp32 + TWAI * Fix: fix incorrect formatting * Adding more documentation to rom, and soc peripherals for multiple chips * Adding documentation for multiple peripherals * Adding SOC module documentation * Analog and clock modules are documented * Adding module-level documentation for DMA and INTERRUPT peripherals * Finishing job + minor fixes * Fix unopened HTML break * Rustfmt adjustment formatting Fix typo * Add CHANGELOG record Fix typo * Fix typos, mistakes, improving docs Co-authored-by: Dániel Buga <bugadani@gmail.com> Fix typo Co-authored-by: Dániel Buga <bugadani@gmail.com> Fix typo Co-authored-by: Dániel Buga <bugadani@gmail.com> Fix typo Co-authored-by: Dániel Buga <bugadani@gmail.com> fix typo Co-authored-by: Dániel Buga <bugadani@gmail.com> Fix typo Co-authored-by: Dániel Buga <bugadani@gmail.com> Fix typo Co-authored-by: Scott Mabin <scott@mabez.dev> Fixing typos, mistakes, improving docs. * Fix formatting, mistakes and typos * Fixing a bunch of logical, grammatical and formatting mistakes	2023-08-09 06:33:50 -07:00
Jesse Braham	5af8b6387a	Clean up re-exports and make small improvements to documentation (#607) ... * Create issue_handler.yml * No longer re-export `embedded-hal`, hide exported macros in documentation * Add simple package-level documentation for each HAL package * Clean up/simplify re-exports * Fix the examples that I broke * Ensure top-level modules/types/functions have doc comments * Update CHANGELOG * Re-export the `soc::psram` module where available --------- Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com>	2023-06-22 06:46:50 -07:00
Jesse Braham	984b7fc042	Refactor chip-specific code into esp_hal_common::soc module (#412) ... * Create an `soc` module with a submodule for each chip, move `peripherals` in * Move the `cpu_control` module into `soc` * Move the `efuse` module into `soc` * Refactor type definitions from `gpio` module into `soc` * Put all embassy-related files in a common directory * Change visibility of `GpioPin` constructor	2023-02-28 07:49:41 -08:00