codo/spec/_templates/methods/curly_method_documentation.coffee

A CoffeeScript documentation generator.

class App.TestMethodDocumentation extends App.Doc

  # Should be overloaded to change fetch limit.
  #
  # @return Number of items per fetch
  #
  fetchLimit: () -> 5

  # Do it!
  #
  # @see #undo for more information
  #
  # @private
  # @param {String} it The thing to do
  # @param again {Boolean} Do it again
  # @param {Object} options The do options
  # @option options {String} speed The speed
  # @option options {Number} repeat How wany time to repeat
  # @option options {Array<Tasks>} tasks The tasks to do
  # @return {Boolean} When successful executed
  #
  do: (it, again, options) ->

  # Do it!
  #
  # @see #undo for more information
  #
  # @private
  # @param {String} it The thing to do
  # @param again {Boolean} Do it again
  # @param {Object} options The do options
  # @option options {String} speed The speed
  # @option options {Number} repeat How wany time to repeat
  # @option options {Array<Tasks>} tasks The tasks to do
  # @return {Boolean} When successful executed
  #
  doWithoutSpace:(it, again, options)->

  # Do it!
  #
  # @see {#undo} for more information
  #
  # @private
  # @param {String} it The thing to do
  # @param {Object} options The do options
  # @option options {String} speed The speed
  # @option options {Number} repeat How wany time to repeat
  # @option options {Array<Tasks>} tasks The tasks to do
  # @return {Boolean} When successful executed
  #
  @lets_do_it = (it, options) ->