lib/flashsdk/mxmlc.rb in flashsdk-1.0.21.pre vs lib/flashsdk/mxmlc.rb in flashsdk-1.0.22.pre

@@ -1,7 +1,8 @@
 module FlashSDK
 
+  ##
   # The MXMLC task provides a rake front end to the Flex MXMLC command line compiler.
   # This task is integrated with the LibraryTask so that if any dependencies are
   # library tasks, they will be automatically added to the library_path or source_path
   # depending on whether they provide a swc or sources.
   #
@@ -43,9 +44,48 @@
   #   desc "Compile the test harness"
   #   mxmlc 'bin/SomeProjectRunner.swf' => :asunit4 do |t|
   #     configure_tasks t
   #     t.input = 'src/SomeProjectRunner.as'
   #   end
+  #
+  # == FCSH
+  #
+  # Building with MXMLC can be quite slow. If you'd like 
+  # to measure your build times in fractions of a second
+  # rather than minutes, you can use the Flex Compiler 
+  # SHell (FCSH).
+  #
+  # Sprouts makes it incredibly easy to 
+  # use FCSH, following are some simple instructions:
+  #
+  # Open up a new terminal, cd into your project
+  # directory and run:
+  #
+  #    rake fcsh:start
+  #
+  # Open up a new terminal, cd into your project
+  # directory and run whatever Rake task depends
+  # on at least one MXMLC task, and call the
+  # +fcsh+ task first. This can be done on the
+  # terminal like this:
+  #
+  #    rake fcsh test
+  #
+  # More information about FCSH can be found on the {Project Sprouts Blog}[http://projectsprouts.org/2011/01/18/using-fcsh.html].
+  #
+  # == Flex Debugger (FDB)
+  #
+  # Like FCSH, the Flex Debugger can be initiated
+  # by calling (or depending on) the +fdb+ Rake task.
+  #
+  #    rake fdb test
+  #
+  # This will drop you into the Flex Debugger shell
+  # environment, you can type +help+ at anytime to 
+  # learn more about what commands are available.
+  #
+  # You can also type +quit+ or hit CTRL+C to exit
+  # FDB.
   #
   # @see FlashSDK::CompilerBase
   # @see Sprout::Executable
   #
   class MXMLC < CompilerBase