lib/dvdprofiler2xbmc/models/media_files.rb in royw-dvdprofiler2xbmc-0.0.17 vs lib/dvdprofiler2xbmc/models/media_files.rb in royw-dvdprofiler2xbmc-0.0.18

@@ -1,20 +1,21 @@
 # == Synopsis
 # encapsulation of all media files
 class MediaFiles
   attr_reader :medias, :titles, :duplicate_titles
 
-  # given:
-  # directories Array of String directory pathspecs
+  # == Synopsis
+  # directories => Array of String directory pathspecs
   def initialize(directories)
     @medias = find_medias(directories)
     @titles = find_titles(@medias)
     @duplicate_titles = find_duplicate_titles(@titles)
   end
 
   protected
 
+  # == Synopsis
   # find all the media files in the given set of directories
   def find_medias(directories)
     medias = []
     directories.each do |dir|
       Dir.chdir(dir)
@@ -23,10 +24,11 @@
       end
     end
     medias
   end
 
+  # == Synopsis
   # return a hash where the key is the media's title and
   # the value is an Array of Media instances
   def find_titles(medias)
     titles = {}
     medias.each do |media|
@@ -35,9 +37,10 @@
       titles[title] << media
     end
     titles
   end
 
+  # == Synopsis
   # find duplicate titles and return them in a hash
   # where the key is the title and the value is an
   # array of Media objects
   def find_duplicate_titles(titles)
     duplicates = {}