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

Fix inheriting of static members. 

When no explicit staticality stated, try to first inherit from instance
members.  Only when that fails look for static members too.
parent 1cbe1c4b

lib/jsduck/process/inherit_doc.rb

+15 −7
Original line number Diff line number Diff line
@@ -173,14 +173,17 @@ module JsDuck 
        inherit = m[:inheritdoc] || {}

        name = inherit[:member] || m[:name]

        tagname = inherit[:type] || m[:tagname]

        static = inherit[:static] || m[:static]

        # When not explicitly inheriting from static member

        # and the member itself is not static,

        # inherit from instance member.

        static = inherit[:static] || m[:static] || false



        if autodetected?(m)

          # Auto-detected properties can override either a property or a

          # config. So look for both types.

          if tagname == :property

            cfg = cls.find_members(:name => name, :tagname => :cfg, :static => static || false)[0]

            prop = cls.find_members(:name => name, :tagname => :property, :static => static || false)[0]

            cfg = cls.find_members(:name => name, :tagname => :cfg, :static => static)[0]

            prop = cls.find_members(:name => name, :tagname => :property, :static => static)[0]



            if cfg && prop

              prop
@@ -193,12 +196,17 @@ module JsDuck 
            end



          else

            # Unless the auto-detected member is detected as static,

            # look only at instance members.

            cls.find_members(:name => name, :tagname => tagname, :static => static || false)[0]

            cls.find_members(:name => name, :tagname => tagname, :static => static)[0]

          end

        else

          cls.find_members(:name => name, :tagname => tagname, :static => static)[0]

          m = cls.find_members(:name => name, :tagname => tagname, :static => static)[0]

          # When member was not found with explicit staticality and

          # the @inheritdoc tag contained no explicit "static", then

          # look for both static and instance members.

          if !m && !inherit[:static]

            m = cls.find_members(:name => name, :tagname => tagname, :static => nil)[0]

          end

          m

        end

      end

spec/aggregator_inheritdoc_spec.rb

+24 −0
Original line number Diff line number Diff line
@@ -251,6 +251,30 @@ describe JsDuck::Aggregator do 
    end

  end



  describe "@inheritdoc without staticality info inheriting from parent with only a static member" do

    before do

      @docs = parse(<<-EOF)

        /** @class Foo */

          /**

           * @method foo

           * Static method comment.

           * @static

           */



        /** @class Inh1 */

          /**

           * @method foo

           * @inheritdoc Foo#foo

           */

      EOF

      @inh1 = @docs["Inh1"][:members][0]

    end



    it "inherits from the static member" do

      @inh1[:doc].should == "Static method comment."

    end

  end



  describe "recursive @inheritdocs" do

    before do

      @docs = parse(<<-EOF)