hocus pocus docus existus

Author: unsecretised

src/app.rs

@@ -23,6 +23,7 @@ pub enum Page {
     ClipboardHistory,
 }
 
+/// The types of arrow keys
 #[allow(dead_code)]
 #[derive(Debug, Clone)]
 pub enum ArrowKey {
@@ -32,6 +33,7 @@ pub enum ArrowKey {
     Right,
 }
 
+/// The ways the cursor can move when a key is pressed
 #[derive(Debug, Clone)]
 pub enum Move {
     Back,

src/app/tile.rs

@@ -41,19 +41,22 @@ impl Drop for ExtSender {
     fn drop(&mut self) {}
 }
 
+/// All the indexed apps that rustcast can search for
 #[derive(Clone, Debug)]
 struct AppIndex {
     by_name: BTreeMap<String, App>,
 }
 
 impl AppIndex {
+    /// Search for an element in the index that starts with the provided prefix
     fn search_prefix<'a>(&'a self, prefix: &'a str) -> impl Iterator<Item = &'a App> + 'a {
         self.by_name
             .range(prefix.to_string()..) // start at prefix
             .take_while(move |(k, _)| k.starts_with(prefix))
             .map(|(_, v)| v)
     }
 
+    /// Factory function for creating
     pub fn from_apps(options: Vec<App>) -> Self {
         let mut bmap = BTreeMap::new();
         for app in options {

src/utils.rs

@@ -177,6 +177,7 @@ pub(crate) fn get_installed_apps(dir: impl AsRef<Path>, store_icons: bool) -> Ve
         .collect()
 }
 
+/// Open the settings file with the system default editor
 pub fn open_settings() {
     thread::spawn(move || {
         NSWorkspace::new().openURL(&NSURL::fileURLWithPath(
@@ -188,6 +189,7 @@ pub fn open_settings() {
     });
 }
 
+/// Open a provided URL (Platform specific)
 pub fn open_url(url: &str) {
     let url = url.to_owned();
     thread::spawn(move || {
@@ -198,6 +200,7 @@ pub fn open_url(url: &str) {
     });
 }
 
+/// Check if the provided string is a valid url
 pub fn is_valid_url(s: &str) -> bool {
     s.ends_with(".com")
         || s.ends_with(".net")