You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a long-term project, as there's not much point documenting drivers until their interfaces are relatively stable.
Each HAL package should have top-level documentation at the very least. Peripheral drivers should additionally be documented, preferably even containing simple examples as doc tests.
Beginning with module-level documentation, here are all modules which are currently exported by any of the chip-specific HAL packages:
adc
aes
analog
assist_debug
clock
cpu_control
dac
delay
dma
efuse
esp_riscv_rt
gpio
i2c
i2s
interrupt
ledc
lp_core
macros
mcpwm
otg_fs
pcnt
peripheral
peripherals
prelude
psram
radio
reset
rmt
rng
rom
rsa
rtc_cntl
sha
spi
system
systimer
timer
trapframe
twai
uart
ulp_core
usb_serial_jtag
The text was updated successfully, but these errors were encountered:
@IshanDaga if you are willing to work on this then yes, that would be awesome! This is definitely one of our weaker points currently so it'd be great to improve this.
In general (with the exception of the chip support label) any open issue is fair game; if it's assigned to somebody already just ask if they're actively working on it, there's a good chance they are not and that you can take it over 😁
I've documented the Rng peripheral in #650, which can be loosely used as a model for other peripherals. @playfulFence is also working on a number of drivers' documentation.
It's that job nobody wants to do!
This is a long-term project, as there's not much point documenting drivers until their interfaces are relatively stable.
Each HAL package should have top-level documentation at the very least. Peripheral drivers should additionally be documented, preferably even containing simple examples as doc tests.
Beginning with module-level documentation, here are all modules which are currently exported by any of the chip-specific HAL packages:
The text was updated successfully, but these errors were encountered: