source.rb in webgen-0.5.9

- old
+ new

@@ -8,14 +8,18 @@
   #
   # Source classes provide access to the source paths on which the source handlers act.
   #
   # A source class only needs to respond to the method +paths+ which needs to return a set of paths
   # for the source. The returned paths must respond to the method <tt>changed?</tt> (has to return
-  # +true+ if the paths has changed since the last webgen run). The default implementation in the
-  # Path class just returns +true+. One can either derive a specialized path class or define
-  # singleton methods on each path object.
+  # +true+ if the paths has changed since the last webgen run). If a path represents a directory, it
+  # needs to have a trailing slash! The default implementation in the Path class just returns
+  # +true+. One can either derive a specialized path class or define singleton methods on each path
+  # object.
   #
+  # Also note that the returned Path objects should have the meta information <tt>modified_at</tt>
+  # set to the correct last modification time of the path, ie. the value has to be a Time object!
+  #
   # == Sample Source Class
   #
   # Following is a simple source class which has stored the paths and their contents in a hash:
   #
   #   require 'stringio'
@@ -34,13 +38,12 @@
   #     end
   #
   #   end
   #
   # You can use this source class in your website (after placing the code in, for example,
-  # <tt>ext/init.rb</tt>) by updating the <tt>sources</tt> configuration option (the following code
-  # has to be placed after the definition of the +MemorySource+ class):
+  # <tt>ext/init.rb</tt>) by updating the <tt>sources</tt> configuration option:
   #
-  #   WebsiteAccess.website.config['sources'] << ['/', MemorySource]
+  #   WebsiteAccess.website.config['sources'] << ['/', 'MemorySource']
   #
   module Source
 
     autoload :Base, 'webgen/source/base'
     autoload :FileSystem, 'webgen/source/filesystem'