diff --git a/doc/control-file.md b/doc/control-file.md index 7853793a6..5d6c1dc4d 100644 --- a/doc/control-file.md +++ b/doc/control-file.md @@ -98,7 +98,7 @@ related variables. > Note that the control file is not an optional tool to help customize > installation, it is required during installation and without the file, > installation may fail or lead to unexpected results. Control file on installed -> system located in `/etc/YaST2/control.xml` is owned by ${PRODUCT}-release +> system located in `/etc/YaST2/control.xml` is owned by `${PRODUCT}-release` > package. During installation, *linuxrc* searches for a file named diff --git a/src/lib/installation/clients/inst_extrasources.rb b/src/lib/installation/clients/inst_extrasources.rb index 637196666..7c5b2bdf3 100644 --- a/src/lib/installation/clients/inst_extrasources.rb +++ b/src/lib/installation/clients/inst_extrasources.rb @@ -245,7 +245,7 @@ def GetURLsToRegister(registered) # Register the installation sources in offline mode (no network connection required). # The repository metadata will be downloaded by sw_single (or another yast module) when the repostory is enabled # - # @param list list of the sources to register + # @param url_list [Array] list of the sources to register # @return [Array] list of created source IDs def RegisterRepos(url_list) url_list = deep_copy(url_list) diff --git a/src/lib/installation/clients/inst_update_installer.rb b/src/lib/installation/clients/inst_update_installer.rb index 35498c9e1..bd643e1e8 100644 --- a/src/lib/installation/clients/inst_update_installer.rb +++ b/src/lib/installation/clients/inst_update_installer.rb @@ -418,7 +418,7 @@ def remote_url?(url) # Ask the user about checking network configuration. If she/he accepts, # the `inst_lan` client will be launched. # - # @param url [URI] URL to show in the message + # @param reason [String] reason why user want to check his network configuration # @return [Boolean] true if the network configuration client was launched; # false if the network is not configured. def configure_network?(reason) @@ -459,7 +459,7 @@ def default_url?(uri) # Return a message to be shown when the updates repo could not be probed # - # @param [URI,String] Repository URI + # @param url [URI,String] Repository URI # @return [String] Message including the repository URL # # @see #self_update_url @@ -491,7 +491,7 @@ def require_registration_libraries # Store URL of registration server to be used by inst_scc client # - # @params [URI] Registration server URL. + # @param url [URI] Registration server URL. def store_registration_url(url) data = { "custom_url" => url.to_s } File.write(REGISTRATION_DATA_PATH, data.to_yaml) diff --git a/src/lib/installation/driver_update.rb b/src/lib/installation/driver_update.rb index 939b09a77..ec8ffa844 100644 --- a/src/lib/installation/driver_update.rb +++ b/src/lib/installation/driver_update.rb @@ -50,7 +50,7 @@ class NotFound < StandardError; end class << self # Find driver updates in a given set of directories # - # @param dirs [Array,Pathname] Directories to search for driver updates + # @param update_dirs [Array,Pathname] Directories to search for driver updates # @return [Array] Found driver updates def find(update_dirs) dirs = Array(update_dirs) diff --git a/src/lib/installation/proposal_runner.rb b/src/lib/installation/proposal_runner.rb index 8c1ad7aa9..312842fb4 100644 --- a/src/lib/installation/proposal_runner.rb +++ b/src/lib/installation/proposal_runner.rb @@ -323,8 +323,7 @@ def check_windows_left # Call a submodule's AskUser() function. # - # @param [String] submodule name of the submodule's proposal dispatcher - # @param has_next force a "next" button even if the submodule would otherwise rename it + # @param [String] input passed link from proposal dispatcher # @return workflow_sequence see proposal-API.txt, or nil if the link cannot be handled # (is read-only) def submod_ask_user(input) diff --git a/src/lib/installation/proposal_store.rb b/src/lib/installation/proposal_store.rb index d5f40ddb9..7a4d64f55 100644 --- a/src/lib/installation/proposal_store.rb +++ b/src/lib/installation/proposal_store.rb @@ -372,8 +372,8 @@ def should_run_proposals_again?(proposals) # Returns whether given trigger definition is correct # e.g., all mandatory parts are there # - # @param [Hash] trigger definition - # @rturn [Boolean] whether it is correct + # @param [Hash] trigger_def definition + # @return [Boolean] whether it is correct def valid_trigger?(trigger_def) trigger_def.key?("expect") && trigger_def["expect"].is_a?(Hash) && @@ -551,7 +551,7 @@ def order_with_tabs # Build the full proposal module name including the "_proposal" suffix. # The sufix is not added when it is already present. - # @param [String] full or short proposal module name + # @param [String] name full or short proposal module name # @return [String] full proposal module name def full_module_name(name) # already a full name? diff --git a/src/lib/installation/remote_finish_client.rb b/src/lib/installation/remote_finish_client.rb index 3703ea39c..243e139e5 100644 --- a/src/lib/installation/remote_finish_client.rb +++ b/src/lib/installation/remote_finish_client.rb @@ -69,7 +69,7 @@ def title # Modes in which #enable_remote should be called # - # @return Array + # @return [Array] def modes Yast::Linuxrc.vnc ? [:installation, :autoinst] : [] end diff --git a/src/lib/installation/update_repository.rb b/src/lib/installation/update_repository.rb index 0735622ff..d0d55484a 100644 --- a/src/lib/installation/update_repository.rb +++ b/src/lib/installation/update_repository.rb @@ -332,7 +332,8 @@ def repo_status # Mount the squashed filesystem containing updates # - # @param path [Pathname] Mountpoint + # @param file [Pathname] file with squashfs content + # @param mountpoint [Pathname] where to mount # # @raise CouldNotMountUpdate # diff --git a/src/lib/installation/updates_manager.rb b/src/lib/installation/updates_manager.rb index c4519401a..ffecea081 100644 --- a/src/lib/installation/updates_manager.rb +++ b/src/lib/installation/updates_manager.rb @@ -62,7 +62,7 @@ class CouldNotProbeRepo < RepoError; end # At instantiation time, this class looks for existin driver # updates in the given `duds_path`. # - # @param duds_path [Pathname] Path where driver updates are supposed to live + # @param duds_paths [Pathname] Path where driver updates are supposed to live def initialize(duds_paths = DRIVER_UPDATES_PATHS) @repositories = [] @driver_updates = Installation::DriverUpdate.find(duds_paths) diff --git a/src/lib/transfer/file_from_url.rb b/src/lib/transfer/file_from_url.rb index c9ebfce62..f2d83be9b 100644 --- a/src/lib/transfer/file_from_url.rb +++ b/src/lib/transfer/file_from_url.rb @@ -44,7 +44,7 @@ def initialize_file_from_url end # Basename - # @param string path + # @param filePath [String] path # @return [String] basename def basename(filePath) pathComponents = Builtins.splitstring(filePath, "/") @@ -57,7 +57,7 @@ def basename(filePath) end # Get directory name - # @param string path + # @param filePath [String] path # @return [String] dirname def dirname(filePath) pathComponents = Builtins.splitstring(filePath, "/") diff --git a/src/modules/SystemFilesCopy.rb b/src/modules/SystemFilesCopy.rb index 6903c44dd..1e7a9e5c9 100644 --- a/src/modules/SystemFilesCopy.rb +++ b/src/modules/SystemFilesCopy.rb @@ -70,8 +70,7 @@ def main # If the path exists but it is not a directory, it tries to create another # directory and returns its name. 'nil' is returned when everythig fails. # - # @param string mnt_tmpdir - # #return string mnt_tmpdir (maybe changed) + # @param create_directory [String] directory to create def CreateDirectoryIfMissing(create_directory) # path already exists if FileUtils.Exists(create_directory) @@ -433,7 +432,7 @@ def GetUseControlFileDef # Sets whether to use copy_files from control file # - # @param boolean whether to use them + # @param new_value [Boolean] whether to use them # @see #GetUseControlFileDef def SetUseControlFileDef(new_value) if new_value.nil? @@ -459,7 +458,7 @@ def GetCopySystemFiles # Sets new rules which files will be copied during installation. # # @see FATE #305019: configure the files to copy from a previous installation - # @param list of new definitions + # @param new_copy_files[Array] of new definitions # # # **Structure:**