From 6cbdc3b0ac092c74fc5905d6528727564a0bfa58 Mon Sep 17 00:00:00 2001 From: Martin Vidner Date: Fri, 2 Jun 2017 16:12:51 +0200 Subject: [PATCH] Fixed all Yardoc warnings [ci-skip] --- src/lib/y2storage/devices_lists/base.rb | 2 +- src/lib/y2storage/devices_lists/disks_list.rb | 2 +- src/lib/y2storage/devices_lists/filesystems_list.rb | 4 ++-- src/lib/y2storage/fake_device_factory.rb | 8 ++++---- src/lib/y2storage/planned/assigned_space.rb | 2 -- src/lib/y2storage/planned/has_size.rb | 4 ++-- src/lib/y2storage/storage_manager.rb | 1 + 7 files changed, 11 insertions(+), 12 deletions(-) diff --git a/src/lib/y2storage/devices_lists/base.rb b/src/lib/y2storage/devices_lists/base.rb index ac2aab8e87..ee52def521 100644 --- a/src/lib/y2storage/devices_lists/base.rb +++ b/src/lib/y2storage/devices_lists/base.rb @@ -84,7 +84,7 @@ def dup # the objects coming from Storage and the nature of DevicesLists, # heterogeneous lists make no sense. # - # @raises TypeError if the types do not match + # @raise [TypeError] if the types do not match def +(other) if self.class != other.class raise TypeError, "#{other.class} is not a #{self.class}" diff --git a/src/lib/y2storage/devices_lists/disks_list.rb b/src/lib/y2storage/devices_lists/disks_list.rb index 569f430667..5e1e062f74 100644 --- a/src/lib/y2storage/devices_lists/disks_list.rb +++ b/src/lib/y2storage/devices_lists/disks_list.rb @@ -83,7 +83,7 @@ def free_disk_spaces # # @see #with # - # @param [String, Array] device name(s) + # @param value [String, Array] device name(s) # @return [DisksList] def with_name_or_partition(value) disks = with(name: value).to_a diff --git a/src/lib/y2storage/devices_lists/filesystems_list.rb b/src/lib/y2storage/devices_lists/filesystems_list.rb index 6eab1ea1bb..c918f2b216 100644 --- a/src/lib/y2storage/devices_lists/filesystems_list.rb +++ b/src/lib/y2storage/devices_lists/filesystems_list.rb @@ -34,8 +34,8 @@ class FilesystemsList < Base # # @see #with # - # @param [String, Array] single mount point or array of possible - # values + # @param value [String, Array] single mount point, + # or an array of possible values # @return [FilesystemsList] def with_mountpoint(value) with do |fs| diff --git a/src/lib/y2storage/fake_device_factory.rb b/src/lib/y2storage/fake_device_factory.rb index b9ea144b21..554f5b79a6 100644 --- a/src/lib/y2storage/fake_device_factory.rb +++ b/src/lib/y2storage/fake_device_factory.rb @@ -305,8 +305,8 @@ def str_to_ptable_type(string) # # Some of the parameters ("mount_point", "label"...) really belong to the # file system which is a separate factory product, but it is more natural - # to specify this for the partition, so those data are kept in - # @file_system_data to be picked up in create_file_system when needed. + # to specify this for the partition, so those data are kept + # in @file_system_data to be picked up in create_file_system when needed. # # @param parent [String] disk name ("/dev/sda" etc.) # @@ -533,8 +533,8 @@ def create_lvm_vg(_parent, args) # # Some of the parameters ("mount_point", "label"...) really belong to the # file system which is a separate factory product, but it is more natural - # to specify this for the logical volume, so those data are kept in - # @file_system_data to be picked up in create_file_system when needed. + # to specify this for the logical volume, so those data are kept + # in @file_system_data to be picked up in create_file_system when needed. # # @param parent [Object] volume group object # diff --git a/src/lib/y2storage/planned/assigned_space.rb b/src/lib/y2storage/planned/assigned_space.rb index 5f02fb032d..5a0831a064 100644 --- a/src/lib/y2storage/planned/assigned_space.rb +++ b/src/lib/y2storage/planned/assigned_space.rb @@ -186,8 +186,6 @@ def sort_partitions! # If the volumes fit in any order or if it's impossible to make them fit, # the method returns nil. # - # @param size_to_fill [DiskSize] - # @param min_grain [DiskSize] # @return [Planned::Partition, nil] def enforced_last rounded_up = DiskSize.sum(partitions.map(&:min), rounding: min_grain) diff --git a/src/lib/y2storage/planned/has_size.rb b/src/lib/y2storage/planned/has_size.rb index 122a8358ef..506f9157e6 100644 --- a/src/lib/y2storage/planned/has_size.rb +++ b/src/lib/y2storage/planned/has_size.rb @@ -134,8 +134,8 @@ def distribute_extra_space!(candidates, extra_size, rounding) # Devices that may grow when distributing the extra space # - # @param [Array] - # @return [Array] + # @param devices [Array] + # @return [Array] def extra_space_candidates(devices) devices.select { |dev| dev.size < dev.max_size } end diff --git a/src/lib/y2storage/storage_manager.rb b/src/lib/y2storage/storage_manager.rb index 25d2cc3754..cc73deda82 100644 --- a/src/lib/y2storage/storage_manager.rb +++ b/src/lib/y2storage/storage_manager.rb @@ -75,6 +75,7 @@ class StorageManager # @param path [String] original path (without prefix) # @return [String] + # @param storage_environment [::Storage::Environment] def initialize(storage_environment) @storage = Storage::Storage.new(storage_environment) activate_callbacks = Callbacks::Activate.new