Sha256: 08da85dacbda7fc99a4afa74bf64cd4093145109177f84321d6b3eaae0a991e5

Contents?: true

Size: 1.41 KB

Versions: 1

Compression:

Stored size: 1.41 KB

Contents

## initialize

Load schedule text written in Ruby DSL.

    check do |ruby|
      Detroit::Schedule.new(ruby)
    end

    ok <<-HERE
      Email :myself do |s|
        s.mailto = 'transfire@gmail.com'
        s.active = true
      end

      Syntax do |s|
        s.exclude = ['lib/plugins']
        s.active  = false
      end
    HERE

Load schedule from a file written in Ruby DSL.

    check do |file|
      path = File.join(root_dir, file)
      Detroit::Schedule.new(File.new(path))
    end

    ok 'samples/example_schedule.rb'

Load schedule text written in YAML"

    check do |yaml|
      Detroit::Schedule.new(yaml)
    end

    ok <<-HERE
      ---
      myself:
        service: email
        mailto : transfire@gmail.com
        active : true
      end

      syntax:
        exclude: [lib/plugins]
        active : false
    HERE

Load schedule from a file written in YAML.

    check do |file|
      path = File.join(root_dir, file)
      Detroit::Schedule.new(File.new(path))
    end

    ok 'samples/example_schedule.yml'


= RDoc Plugin

The RDoc plugin should generate rdoc doumentation according
to the parameters provided.

Given a suitable project.

  Dir.chdir 'sample'

Now if we run 'syckle document' on the sample project.

  `detroit document`

The documentation should be generated as expected.

  File.assert.directory?('doc/rdoc')

Lets clean up after ourselves.

  FileUtils.rm_r 'doc'
  Dir.chdir '..'








Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
detroit-0.2.0 QED.rdoc