fix formatting and add reference

This commit is contained in:
Jeanie 2024-04-26 01:03:25 +09:00
parent f04f998168
commit 77d205a4c2

View file

@ -200,16 +200,21 @@ impl Modals {
///
/// - `qrtext` turns submitted text into a qr code.
/// - This dialog blocks until the notification has been acknowledged via [ Press any key ].
/// - Dialog does not scroll, burden is on the consumer to make sure text + qr code do not overflow available space.
/// - Dialog does not scroll, burden is on the consumer to make sure text + qr code do not overflow
/// available space.
///
/// # Examples
/// ```
/// use xous_names::XousNames;
/// use modals::Modals;
///
/// use xous_names::XousNames;
/// let xns = XousNames::new().unwrap();
/// let modals = Modals::new(&xns).unwrap();
/// modals.show_notification("Check the wiki:", Some("https://github.com/betrusted-io/betrusted-wiki/wiki")).unwrap();
/// modals
/// .show_notification(
/// "Check the wiki:",
/// Some("https://github.com/betrusted-io/betrusted-wiki/wiki"),
/// )
/// .unwrap();
/// ```
pub fn show_notification(&self, notification: &str, qrtext: Option<&str>) -> Result<(), xous::Error> {
self.lock();