singleton classes type for instance

Signed-off-by: Laurent Martin <laurent.martin.l@gmail.com>

Author: laurent-martin

lib/aspera/agent/factory.rb

@@ -6,6 +6,10 @@
 module Aspera
   module Agent
     # Factory for Agents
+    #
+    # @!method self.instance
+    #   Returns the singleton instance of Factory
+    #   @return [Factory] the singleton instance
     class Factory
       include Singleton
 

lib/aspera/ascp/installation.rb

@@ -27,6 +27,10 @@ module Ascp
     # It is used by object : AgentDirect to find necessary resources
     # By default it takes the first Aspera product found
     # The user can specify `ascp` location by calling: `sdk_folder=` method
+    #
+    # @!method self.instance
+    #   Returns the singleton instance of Installation
+    #   @return [Installation] the singleton instance
     class Installation
       include Singleton
 

lib/aspera/cli/plugins/factory.rb

@@ -9,6 +9,9 @@ module Aspera
   module Cli
     # Instantiate plugin from well-known locations
     module Plugins
+      # @!method self.instance
+      #   Returns the singleton instance of Factory
+      #   @return [Factory] the singleton instance
       class Factory
         include Singleton
 

lib/aspera/data_repository.rb

@@ -6,6 +6,10 @@
 
 module Aspera
   # a simple binary data repository
+  #
+  # @!method self.instance
+  #   Returns the singleton instance of DataRepository
+  #   @return [DataRepository] the singleton instance
   class DataRepository
     include Singleton
 

lib/aspera/environment.rb

@@ -13,6 +13,10 @@
 
 module Aspera
   # detect OS, architecture, and specific stuff
+  #
+  # @!method self.instance
+  #   Returns the singleton instance of Environment
+  #   @return [Environment] the singleton instance
   class Environment
     include Singleton
 
@@ -266,6 +270,7 @@ def fix_home
       return unless @os.eql?(OS_WINDOWS) && ENV.key?('USERPROFILE') && Dir.exist?(ENV.fetch('USERPROFILE', nil))
       ENV['HOME'] = ENV.fetch('USERPROFILE', nil)
       Log.log.debug{"Windows: set HOME to USERPROFILE: #{Dir.home}"}
+      nil
     end
 
     def graphical?

lib/aspera/log.rb

@@ -54,6 +54,10 @@ def make_methods(str_level)
 
 module Aspera
   # Singleton object for logging
+  #
+  # @!method self.instance
+  #   Returns the singleton instance of Log
+  #   @return [Log] the singleton instance
   class Log
     include Singleton
 

lib/aspera/oauth/factory.rb

@@ -7,6 +7,10 @@
 module Aspera
   module OAuth
     # Factory to create tokens and manage their cache
+    #
+    # @!method self.instance
+    #   Returns the singleton instance of Factory
+    #   @return [Factory] the singleton instance
     class Factory
       include Singleton
 

lib/aspera/preview/file_types.rb

@@ -8,6 +8,10 @@
 module Aspera
   module Preview
     # function conversion_type returns one of the types: CONVERSION_TYPES
+    #
+    # @!method self.instance
+    #   Returns the singleton instance of FileTypes
+    #   @return [FileTypes] the singleton instance
     class FileTypes
       include Singleton
 

lib/aspera/products/connect.rb

@@ -5,6 +5,9 @@
 
 module Aspera
   module Products
+    # @!method self.instance
+    #   Returns the singleton instance of Connect
+    #   @return [Connect] the singleton instance
     class Connect
       include Singleton
 

lib/aspera/rest.rb

@@ -30,6 +30,10 @@ module Aspera
   # @param download_partial_suffix [String] suffix for partial download
   # @param session_cb [lambda] lambda called on new HTTP session. Takes the Net::HTTP as arg. Used to change parameters on creation.
   # @param progress_bar [Object] progress bar object called for file transfer
+  #
+  # @!method self.instance
+  #   Returns the singleton instance of RestParameters
+  #   @return [RestParameters] the singleton instance
   class RestParameters
     include Singleton