Commit f41e6750 authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Rename Chainable to ReturnValues. 

Planning to extend its functionality to auto-generation of other return
values too.
parent cab57d1f

lib/jsduck/app.rb

+2 −2
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ require 'jsduck/assets' 
require 'jsduck/json_duck'

require 'jsduck/io'

require 'jsduck/importer'

require 'jsduck/chainable'

require 'jsduck/return_values'

require 'jsduck/lint'

require 'jsduck/template_dir'

require 'jsduck/class_writer'
@@ -49,7 +49,7 @@ module JsDuck 
      @relations = filter_classes(result)

      InheritDoc.new(@relations).resolve_all

      Importer.import(@opts.imports, @relations, @opts.new_since)

      Chainable.auto_detect(@relations)

      ReturnValues.auto_detect(@relations)

      Lint.new(@relations).run



      # Initialize guides, videos, examples, ...

lib/jsduck/chainable.rb→lib/jsduck/return_values.rb

+3 −3
Original line number Diff line number Diff line 
module JsDuck



  # Auto-detector of @chainable tags.

  # Auto-detector return values and @chainable tags.

  #

  # Adds @chainable tag when doc-comment contains @return {OwnerClass}

  # this.  Also the other way around: when @chainable found, adds

  # appropriate @return.

  class Chainable

  class ReturnValues

    # Only this static method of this class should be called.

    def self.auto_detect(relations)

      Chainable.new(relations).process_all!

      ReturnValues.new(relations).process_all!

    end



    def initialize(relations)

spec/aggregator_chainable_spec.rb

+2 −2
Original line number Diff line number Diff line
@@ -2,14 +2,14 @@ require "jsduck/aggregator" 
require "jsduck/source_file"

require "jsduck/class"

require "jsduck/relations"

require "jsduck/chainable"

require "jsduck/return_values"



describe JsDuck::Aggregator do

  def parse(string)

    agr = JsDuck::Aggregator.new

    agr.aggregate(JsDuck::SourceFile.new(string))

    relations = JsDuck::Relations.new(agr.result.map {|doc| JsDuck::Class.new(doc) })

    JsDuck::Chainable.auto_detect(relations)

    JsDuck::ReturnValues.auto_detect(relations)

    relations

  end