max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document all public apis of embedded-hal-internal

Browse Source 
* Make some fields and functions non-public where possible.
* Enable doc warnings for missing public API docs.
This commit is contained in:
Ulf Lilleengen
2023-12-08 20:42:52 +01:00
parent c94a9b8d75
commit 02b7a833d9
6 changed files with 27 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
embassy-hal-internal/src/macros.rs
View File

@ -1,3 +1,4 @@
/// Types for the peripheral singletons.
#[macro_export]
macro_rules! peripherals_definition {
($($(#[$cfg:meta])? $name:ident),*$(,)?) => {
@ -29,6 +30,7 @@ macro_rules! peripherals_definition {
};
}
/// Define the peripherals struct.
#[macro_export]
macro_rules! peripherals_struct {
($($(#[$cfg:meta])? $name:ident),*$(,)?) => {
@ -87,6 +89,7 @@ macro_rules! peripherals_struct {
};
}
/// Defining peripheral type.
#[macro_export]
macro_rules! peripherals {
($($(#[$cfg:meta])? $name:ident),*$(,)?) => {
@ -105,6 +108,7 @@ macro_rules! peripherals {
};
}
/// Convenience converting into reference.
#[macro_export]
macro_rules! into_ref {
($($name:ident),*) => {
@ -114,6 +118,7 @@ macro_rules! into_ref {
}
}
/// Implement the peripheral trait.
#[macro_export]
macro_rules! impl_peripheral {
($type:ident) => {