Skip to content

Commit 75c6010

Browse files
committed
[DOC] nodoc for private methods and module
1 parent 637e4ec commit 75c6010

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

lib/fileutils.rb

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2028,21 +2028,22 @@ def touch(list, noop: nil, verbose: nil, mtime: nil, nocreate: nil)
20282028

20292029
private
20302030

2031-
module StreamUtils_
2031+
module StreamUtils_ # :nodoc:
2032+
20322033
private
20332034

20342035
case (defined?(::RbConfig) ? ::RbConfig::CONFIG['host_os'] : ::RUBY_PLATFORM)
20352036
when /mswin|mingw/
2036-
def fu_windows?; true end
2037+
def fu_windows?; true end #:nodoc:
20372038
else
2038-
def fu_windows?; false end
2039+
def fu_windows?; false end #:nodoc:
20392040
end
20402041

20412042
def fu_copy_stream0(src, dest, blksize = nil) #:nodoc:
20422043
IO.copy_stream(src, dest)
20432044
end
20442045

2045-
def fu_stream_blksize(*streams)
2046+
def fu_stream_blksize(*streams) #:nodoc:
20462047
streams.each do |s|
20472048
next unless s.respond_to?(:stat)
20482049
size = fu_blksize(s.stat)
@@ -2051,14 +2052,14 @@ def fu_stream_blksize(*streams)
20512052
fu_default_blksize()
20522053
end
20532054

2054-
def fu_blksize(st)
2055+
def fu_blksize(st) #:nodoc:
20552056
s = st.blksize
20562057
return nil unless s
20572058
return nil if s == 0
20582059
s
20592060
end
20602061

2061-
def fu_default_blksize
2062+
def fu_default_blksize #:nodoc:
20622063
1024
20632064
end
20642065
end
@@ -2503,7 +2504,7 @@ def fu_output_message(msg) #:nodoc:
25032504
end
25042505
private_module_function :fu_output_message
25052506

2506-
def fu_split_path(path)
2507+
def fu_split_path(path) #:nodoc:
25072508
path = File.path(path)
25082509
list = []
25092510
until (parent, base = File.split(path); parent == path or parent == ".")
@@ -2524,7 +2525,7 @@ def fu_relative_components_from(target, base) #:nodoc:
25242525
end
25252526
private_module_function :fu_relative_components_from
25262527

2527-
def fu_clean_components(*comp)
2528+
def fu_clean_components(*comp) #:nodoc:
25282529
comp.shift while comp.first == "."
25292530
return comp if comp.empty?
25302531
clean = [comp.shift]
@@ -2543,11 +2544,11 @@ def fu_clean_components(*comp)
25432544
private_module_function :fu_clean_components
25442545

25452546
if fu_windows?
2546-
def fu_starting_path?(path)
2547+
def fu_starting_path?(path) #:nodoc:
25472548
path&.start_with?(%r(\w:|/))
25482549
end
25492550
else
2550-
def fu_starting_path?(path)
2551+
def fu_starting_path?(path) #:nodoc:
25512552
path&.start_with?("/")
25522553
end
25532554
end

0 commit comments

Comments
 (0)