alex/agb
1
0
Fork 0
mirror of https://github.com/italicsjenga/agb.git synced 2024-12-23 16:21:33 +11:00
Code Issues Packages Projects Releases Wiki Activity

fix doc example

Browse source
This commit is contained in:
Corwin 2023-04-06 21:28:52 +01:00
parent 96a321504c
commit 686ded4377
No known key found for this signature in database
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
agb/src/interrupt.rs
View file

@ -228,6 +228,7 @@ fn interrupt_to_root(interrupt: Interrupt) -> &'static InterruptRoot {
/// ///
/// # Safety /// # Safety
/// * You *must not* allocate in an interrupt. /// * You *must not* allocate in an interrupt.
/// - Many functions in agb allocate and it isn't always clear.
/// ///
/// # Staticness /// # Staticness
/// * The closure must be static because forgetting the interrupt handler will /// * The closure must be static because forgetting the interrupt handler will
@ -240,12 +241,14 @@ fn interrupt_to_root(interrupt: Interrupt) -> &'static InterruptRoot {
/// ```rust,no_run /// ```rust,no_run
/// # #![no_std] /// # #![no_std]
/// # #![no_main] /// # #![no_main]
/// use bare_metal::CriticalSection;
///
/// # fn foo() { /// # fn foo() {
/// # use agb::interrupt::{add_interrupt_handler, Interrupt}; /// use bare_metal::CriticalSection;
/// let _a = add_interrupt_handler(Interrupt::VBlank, |_: CriticalSection| { /// use agb::interrupt::{add_interrupt_handler, Interrupt};
/// agb::println!("Woah there! There's been a vblank!"); /// // Safety: doesn't allocate
/// let _a = unsafe {
/// add_interrupt_handler(Interrupt::VBlank, |_: CriticalSection| {
/// agb::println!("Woah there! There's been a vblank!");
/// }
/// }); /// });
/// # } /// # }
/// ``` /// ```