Skip to content

Commit

Permalink
Fixed all Yardoc warnings
Browse files Browse the repository at this point in the history
[ci-skip]
  • Loading branch information
mvidner committed Jun 2, 2017
1 parent f820a87 commit 6cbdc3b
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 12 deletions.
2 changes: 1 addition & 1 deletion src/lib/y2storage/devices_lists/base.rb
Expand Up @@ -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}"
Expand Down
2 changes: 1 addition & 1 deletion src/lib/y2storage/devices_lists/disks_list.rb
Expand Up @@ -83,7 +83,7 @@ def free_disk_spaces
#
# @see #with
#
# @param [String, Array<String>] device name(s)
# @param value [String, Array<String>] device name(s)
# @return [DisksList]
def with_name_or_partition(value)
disks = with(name: value).to_a
Expand Down
4 changes: 2 additions & 2 deletions src/lib/y2storage/devices_lists/filesystems_list.rb
Expand Up @@ -34,8 +34,8 @@ class FilesystemsList < Base
#
# @see #with
#
# @param [String, Array<String>] single mount point or array of possible
# values
# @param value [String, Array<String>] single mount point,
# or an array of possible values
# @return [FilesystemsList]
def with_mountpoint(value)
with do |fs|
Expand Down
8 changes: 4 additions & 4 deletions src/lib/y2storage/fake_device_factory.rb
Expand Up @@ -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.)
#
Expand Down Expand Up @@ -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
#
Expand Down
2 changes: 0 additions & 2 deletions src/lib/y2storage/planned/assigned_space.rb
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions src/lib/y2storage/planned/has_size.rb
Expand Up @@ -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<HasSize>]
# @return [Array<HasSize>]
def extra_space_candidates(devices)
devices.select { |dev| dev.size < dev.max_size }
end
Expand Down
1 change: 1 addition & 0 deletions src/lib/y2storage/storage_manager.rb
Expand Up @@ -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
Expand Down

0 comments on commit 6cbdc3b

Please sign in to comment.