Commit 685f559d authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Renamed class members #member property to owner. 

This was too confusing.  We still have @member in doc-comments,
but it's translated to owner internally.
parent 152d213b

lib/jsduck/aggregator.rb

+10 −10
Original line number Diff line number Diff line
@@ -69,14 +69,14 @@ module JsDuck 
    # Items without @member belong by default to the preceding class.

    # When no class precedes them - they too are orphaned.

    def add_member(node)

      if node[:member]

        if @classes[node[:member]]

          @classes[node[:member]][node[:tagname]] << node

      if node[:owner]

        if @classes[node[:owner]]

          @classes[node[:owner]][node[:tagname]] << node

        else

          add_orphan(node)

        end

      elsif @current_class

        node[:member] = @current_class[:name]

        node[:owner] = @current_class[:name]

        @current_class[ node[:tagname] ] << node

      else

        add_orphan(node)
@@ -90,19 +90,19 @@ module JsDuck 


    # Inserts available orphans to class

    def insert_orphans(cls)

      members = @orphans.find_all {|node| node[:member] == cls[:name] }

      members = @orphans.find_all {|node| node[:owner] == cls[:name] }

      members.each do |node|

        cls[node[:tagname]] << node

        @orphans.delete(node)

      end

    end



    # Creates classes for orphans that have :member property defined,

    # Creates classes for orphans that have :owner property defined,

    # and then inserts orphans to these classes.

    def classify_orphans

      @orphans.each do |orph|

        if orph[:member]

          class_name = orph[:member]

        if orph[:owner]

          class_name = orph[:owner]

          if !@classes[class_name]

            add_empty_class(class_name)

          end
@@ -116,7 +116,7 @@ module JsDuck 
    # Aliases are currently only supported for methods.

    def populate_aliases

      @aliases.each do |al|

        orig = get_member(al[:alias][:cls], al[:alias][:member])

        orig = get_member(al[:alias][:cls], al[:alias][:owner])

        al[:doc] = al[:doc] + "\n\n" + orig[:doc]

        al[:params] = orig[:params]

        al[:return] = orig[:return]
@@ -135,7 +135,7 @@ module JsDuck 


      add_empty_class("global", "Global variables and functions.")

      @orphans.each do |orph|

        orph[:member] = "global"

        orph[:owner] = "global"

        add_member(orph)

      end

      @orphans = []

lib/jsduck/class.rb

+0 −3
Original line number Diff line number Diff line
@@ -98,9 +98,6 @@ module JsDuck 
    #

    # When parent and child have members with same name,

    # member from child overrides tha parent member.

    #

    # We also set :member property to each member to the full class

    # name where it belongs, so one can tell them apart afterwards.

    def members_hash(type)

      all_members = parent ? parent.members_hash(type) : {}

lib/jsduck/doc_parser.rb

+1 −1
Original line number Diff line number Diff line
@@ -280,7 +280,7 @@ module JsDuck 
        @current_tag[:cls] = ident_chain

        if look(/#\w/)

          @input.scan(/#/)

          @current_tag[:member] = ident

          @current_tag[:owner] = ident

        end

      end

      skip_white

lib/jsduck/members.rb

+1 −1
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ module JsDuck 
        [:cfg, :property, :method, :event].each do |type|

          cls.members(type).each do |m|

            # skip inherited items and constructors

            if m[:member] == cls.full_name && m[:name] != cls.short_name

            if m[:owner] == cls.full_name && m[:name] != cls.short_name

              list << member_node(m, cls)

            end

          end

lib/jsduck/merger.rb

+9 −9
Original line number Diff line number Diff line
@@ -70,7 +70,7 @@ module JsDuck 
      result[:method] = []

      if groups[:constructor].length > 0

        constr = create_method(groups[:constructor], {})

        constr[:member] = result[:name]

        constr[:owner] = result[:name]

        result[:method] << constr

      end

      result[:property] = []
@@ -134,7 +134,7 @@ module JsDuck 
      return add_shared({

        :tagname => :method,

        :name => name,

        :member => detect_member(doc_map),

        :owner => detect_owner(doc_map),

        :doc => detect_doc(docs),

        :params => detect_params(docs, code),

        :return => detect_return(doc_map, name == "constructor" ? "Object" : "void"),
@@ -146,18 +146,18 @@ module JsDuck 
      return add_shared({

        :tagname => :event,

        :name => detect_name(:event, doc_map, code),

        :member => detect_member(doc_map),

        :owner => detect_owner(doc_map),

        :doc => detect_doc(docs),

        :params => detect_params(docs, code),

      }, doc_map)

    end



    def create_cfg(docs, code, member = nil)

    def create_cfg(docs, code, owner = nil)

      doc_map = build_doc_map(docs)

      return add_shared({

        :tagname => :cfg,

        :name => detect_name(:cfg, doc_map, code),

        :member => detect_member(doc_map) || member,

        :owner => detect_owner(doc_map) || owner,

        :type => detect_type(:cfg, doc_map, code),

        :doc => detect_doc(docs),

      }, doc_map)
@@ -168,7 +168,7 @@ module JsDuck 
      return add_shared({

        :tagname => :property,

        :name => detect_name(:property, doc_map, code),

        :member => detect_member(doc_map),

        :owner => detect_owner(doc_map),

        :type => detect_type(:property, doc_map, code),

        :doc => detect_doc(docs),

      }, doc_map)
@@ -179,7 +179,7 @@ module JsDuck 
      return add_shared({

        :tagname => :css_var,

        :name => detect_name(:css_var, doc_map, code),

        :member => detect_member(doc_map),

        :owner => detect_owner(doc_map),

        :type => detect_type(:css_var, doc_map, code),

        :doc => detect_doc(docs),

      }, doc_map)
@@ -190,7 +190,7 @@ module JsDuck 
      return add_shared({

        :tagname => :css_mixin,

        :name => detect_name(:css_mixin, doc_map, code),

        :member => detect_member(doc_map),

        :owner => detect_owner(doc_map),

        :doc => detect_doc(docs),

        :params => detect_params(docs, code),

      }, doc_map)
@@ -224,7 +224,7 @@ module JsDuck 
      end

    end



    def detect_member(doc_map)

    def detect_owner(doc_map)

      if doc_map[:member]

        doc_map[:member].first[:member]

      else