docs: apps doc comments

docs: apps doc comments

4 files changed, 105 insertions, 18 deletions

diff --git a/docs/result-dev b/docs/result-dev
deleted file mode 120000
index 52fdae0..0000000
--- a/docs/result-dev
+++ /dev/null
@@ -1 +0,0 @@
-/nix/store/080gmk15wbbjx258rxzsq19ykjdrvl39-astal-0.1.0-dev
\ No newline at end of file
diff --git a/lib/apps/application.vala b/lib/apps/application.vala
index 75ff6b2..7e20b06 100644
--- a/lib/apps/application.vala
+++ b/lib/apps/application.vala
@@ -1,12 +1,45 @@
-namespace AstalApps {
-public class Application : Object {
+public class AstalApps.Application : Object {
+    /**
+     * The underlying DesktopAppInfo.
+     */
     public DesktopAppInfo app { get; construct set; }
+
+    /**
+     * The number of times [[email protected]] was called on this Application.
+     */
     public int frequency { get; set; default = 0; }
+
+    /**
+     * The name of this Application.
+     */
     public string name { get { return app.get_name(); } }
+
+    /**
+     * Name of the .desktop of this Application.
+     */
     public string entry { get { return app.get_id(); } }
+
+    /**
+     * Description of this Application.
+     */
     public string description { get { return app.get_description(); } }
+
+    /**
+     * The StartupWMClass field from the desktop file.
+     * This represents the WM_CLASS property of the main window of the application.
+     */
     public string wm_class { get { return app.get_startup_wm_class(); } }
+
+    /**
+     * `Exec` field from the desktop file.
+     * Note that if you want to launch this Application you should use the [[email protected]] method.
+     */
     public string executable { owned get { return app.get_string("Exec"); } }
+
+    /**
+     * `Icon` field from the desktop file.
+     * This is usually a named icon or a path to a file.
+     */
     public string icon_name { owned get { return app.get_string("Icon"); } }
 
     internal Application(string id, int? frequency = 0) {
@@ -14,10 +47,17 @@ public class Application : Object {
         this.frequency = frequency;
     }
 
+    /**
+     * Get a value from the .desktop file by its key.
+     */
     public string get_key(string key) {
         return app.get_string(key);
     }
 
+    /**
+     * Launches this application.
+     * The launched application inherits the environment of the launching process
+     */
     public bool launch() {
         try {
             var s = app.launch(null, null);
@@ -29,7 +69,7 @@ public class Application : Object {
         }
     }
 
-    public Score fuzzy_match(string term) {
+    internal Score fuzzy_match(string term) {
         var score = Score();
         if (name != null)
             score.name = fuzzy_match_string(term, name);
@@ -43,7 +83,7 @@ public class Application : Object {
         return score;
     }
 
-    public Score exact_match(string term) {
+    internal Score exact_match(string term) {
         var score = Score();
         if (name != null)
             score.name = name.down().contains(term.down()) ? 1 : 0;
@@ -71,14 +111,9 @@ public class Application : Object {
     }
 }
 
-int min3(int a, int b, int c) {
-    return (a < b) ? ((a < c) ? a : c) : ((b < c) ? b : c);
-}
-
-public struct Score {
+public struct AstalApps.Score {
     int name;
     int entry;
     int executable;
     int description;
 }
-}
diff --git a/lib/apps/apps.vala b/lib/apps/apps.vala
index b07961e..c96a2b2 100644
--- a/lib/apps/apps.vala
+++ b/lib/apps/apps.vala
@@ -1,23 +1,70 @@
-namespace AstalApps {
-public class Apps : Object {
+public class AstalApps.Apps : Object {
     private string cache_directory;
     private string cache_file;
     private List<Application> _list;
     private HashTable<string, int> frequents { get; private set; }
 
+    /**
+     * Indicates wether hidden applications should included in queries.
+     */
     public bool show_hidden { get; set; }
+
+    /**
+     * Full list of available applications.
+     */
     public List<weak Application> list { owned get { return _list.copy(); } }
 
+    /**
+     * The minimum score the application has to meet in order to be included in queries.
+     */
     public int min_score { get; set; default = 0; }
 
+    /**
+     * Extra multiplier to apply when matching the `name` of an application.
+     * Defaults to `2`
+     */
     public double name_multiplier { get; set; default = 2; }
+
+    /**
+     * Extra multiplier to apply when matching the entry of an application.
+     * Defaults to `1`
+     */
     public double entry_multiplier { get; set; default = 1; }
+
+    /**
+     * Extra multiplier to apply when matching the executable of an application.
+     * Defaults to `1`
+     */
     public double executable_multiplier { get; set; default = 1; }
+
+    /**
+     * Extra multiplier to apply when matching the description of an application.
+     * Defaults to `0.5`
+     */
     public double description_multiplier { get; set; default = 0.5; }
 
+    /**
+     * Consider the name of an application during queries.
+     * Defaults to `true`
+     */
     public bool include_name { get; set; default = true; }
+
+    /**
+     * Consider the entry of an application during queries.
+     * Defaults to `false`
+     */
     public bool include_entry { get; set; default = false; }
+
+    /**
+     * Consider the executable of an application during queries.
+     * Defaults to `false`
+     */
     public bool include_executable { get; set; default = false; }
+
+    /**
+     * Consider the description of an application during queries.
+     * Defaults to `false`
+     */
     public bool include_description { get; set; default = false; }
 
     construct {
@@ -65,7 +112,7 @@ public class Apps : Object {
         return r;
     }
 
-    public List<weak Application> query(string? search = "", bool exact = false) {
+    internal List<weak Application> query(string? search = "", bool exact = false) {
         if (search == null)
             search = "";
 
@@ -114,14 +161,23 @@ public class Apps : Object {
         return arr;
     }
 
+    /**
+     * Query the `list` of applications with a fuzzy matching algorithm.
+     */
     public List<weak Application> fuzzy_query(string? search = "") {
         return query(search, false);
     }
 
+    /**
+     * Query the `list` of applications with a simple string matching algorithm.
+     */
     public List<weak Application> exact_query(string? search = "") {
         return query(search, true);
     }
 
+    /**
+     * Reload the `list` of Applications.
+     */
     public void reload() {
         var arr = AppInfo.get_all();
 
@@ -169,4 +225,3 @@ public class Apps : Object {
         }
     }
 }
-}
diff --git a/lib/apps/fuzzy.vala b/lib/apps/fuzzy.vala
index f93b2eb..97277bd 100644
--- a/lib/apps/fuzzy.vala
+++ b/lib/apps/fuzzy.vala
@@ -1,11 +1,9 @@
-
 namespace AstalApps {
-
 private int max(int a, int b) {
     return a > b ? a : b;
 }
 
-public int fuzzy_match_string(string pattern, string str) {
+private int fuzzy_match_string(string pattern, string str) {
     const int unmatched_letter_penalty = -1;
     int score = 100;