From cd5f6a1ae2fd98cd8a85c01c9908a970198e1885 Mon Sep 17 00:00:00 2001 From: Jeanie Date: Tue, 23 Apr 2024 01:18:56 +0900 Subject: [PATCH] adding documentation for show_notification --- services/modals/src/lib.rs | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/services/modals/src/lib.rs b/services/modals/src/lib.rs index 6a0cafed1..e42222f33 100644 --- a/services/modals/src/lib.rs +++ b/services/modals/src/lib.rs @@ -196,7 +196,17 @@ impl Modals { } } - /// this blocks until the notification has been acknowledged. + /// Text/QR code notification modal dialog. + /// + /// - `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. + /// + /// # Examples + /// ``` + /// let modals = Modals::new(&xns).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(); let qrtext = match qrtext {