asdoc.rb in flashsdk-1.0.22.pre

- old
+ new

@@ -1,7 +1,22 @@
 module FlashSDK
 
+  ##
+  # The AsDoc executable is a wrapper around the Flex SDK binary of the same name.
+  #
+  # Following is a simple example of the asdoc Rake task:
+  #
+  #   desc "Generate documentation at <%= doc %>/"
+  #   asdoc 'doc' do |t|
+  #     t.doc_sources << 'src'
+  #
+  #     # Exclude test main file
+  #     t.exclude_sources << 'src/SomeProjectRunner.as'
+  #   end
+  #
+  # @see CompilerBase
+  #
   class AsDoc < CompilerBase
 
     ##
     # The default prefix for shell params.
     set :default_prefix, '-'
@@ -29,10 +44,9 @@
     add_param :date_in_footer, Boolean
 
     ##
     # List of source file to include in the documentation.
     add_param :doc_sources, Files
-
     add_param_alias :ds, :doc_sources
 
     ##
     # List of classes to include in the documentation.
     add_param :doc_classes, Strings