module/class documentation

lib/launchy/argv.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Launchy
+  # Internal: Ecapsulate the commandline argumens passed to Launchy
+  #
   class Argv
     attr_reader :argv
     def initialize(*args)

lib/launchy/cli.rb

@@ -3,6 +3,8 @@
 require "optparse"
 
 module Launchy
+  # Internal: Command line interface for Launchy
+  #
   class Cli
 
     attr_reader :options

lib/launchy/detect.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Launchy
+  # Internal: Namespace for detecting the environment that Launchy is running in
+  #
   module Detect
   end
 end

lib/launchy/detect/host_os.rb

@@ -3,6 +3,8 @@
 require "rbconfig"
 
 module Launchy::Detect
+  # Internal: Determine the host operating system that Launchy is running on
+  #
   class HostOs
 
     attr_reader :host_os

lib/launchy/detect/host_os_family.rb

@@ -49,20 +49,23 @@ def self.matching_regex
       def app_list(app) app.windows_app_list; end
     end
 
+    # Mac OS X family
     class Darwin < HostOsFamily
       def self.matching_regex
         /(darwin|mac os)/i
       end
       def app_list(app) app.darwin_app_list; end
     end
 
+    # All the *nix family of operating systems, and BSDs
     class Nix < HostOsFamily
       def self.matching_regex
         /(linux|bsd|aix|solaris|sunos|dragonfly)/i
       end
       def app_list(app) app.nix_app_list; end
     end
 
+    # Cygwin - if anyone is still using that
     class Cygwin < HostOsFamily
       def self.matching_regex
         /cygwin/i

lib/launchy/detect/nix_desktop_environment.rb

@@ -32,6 +32,7 @@ def self.browsers
     # The list of known desktop environments
     #---------------------------------------
 
+    # KDE desktop environment
     class Kde < NixDesktopEnvironment
       def self.is_current_desktop_environment?
         ENV["KDE_FULL_SESSION"] &&
@@ -43,6 +44,7 @@ def self.browser
       end
     end
 
+    # Gnome desktop environment
     class Gnome < NixDesktopEnvironment
       def self.is_current_desktop_environment?
         ENV["GNOME_DESKTOP_SESSION_ID"] &&
@@ -54,6 +56,7 @@ def self.browser
       end
     end
 
+    # Xfce desktop environment
     class Xfce < NixDesktopEnvironment
       def self.is_current_desktop_environment?
         if Launchy::Application.find_executable("xprop") then

lib/launchy/runner.rb

@@ -2,6 +2,8 @@
 
 require "childprocess"
 module Launchy
+  # Internal: Run a command in a child process
+  #
   class Runner
     def run(cmd, *args)
       raise Launchy::CommandNotFoundError, "No command found to run with args '#{args.join(' ')}'. If this is unexpected, #{Launchy.bug_report_message}" unless cmd

lib/launchy/version.rb

@@ -3,6 +3,7 @@
 module Launchy
   VERSION = "3.0.0"
 
+  # Internal: Version number of Launchy
   module Version
 
     MAJOR   = Integer(VERSION.split(".")[0])