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

Also support @alias #membername.

parent ec3478be

lib/jsduck/doc_parser.rb

+1 −1
Original line number Diff line number Diff line
@@ -124,7 +124,7 @@ module JsDuck 
          at_member

        elsif look(/@inherit[dD]oc\b/)

          at_inheritdoc

        elsif look(/@alias\s+[\w.]+#\w+/)

        elsif look(/@alias\s+([\w.]+)?#\w+/)

          # For backwards compatibility.

          # @alias tag was used as @inheritdoc before

          at_inheritdoc

spec/aggregator_inheritdoc_spec.rb

+16 −2
Original line number Diff line number Diff line
@@ -344,7 +344,7 @@ describe JsDuck::Aggregator do 
    end

  end



  describe "@inheritdoc with member name parameter" do

  shared_examples_for "with member name parameter" do

    before do

      @docs = parse(<<-EOF)

        /**
@@ -356,7 +356,7 @@ describe JsDuck::Aggregator do 
           */

          /**

           * @method foobar

           * @inheritdoc #bar

           * #{@tagname} #bar

           * New comment.

           */

      EOF
@@ -368,6 +368,20 @@ describe JsDuck::Aggregator do 
    end

  end



  describe "@inheritdoc" do

    before do

      @tagname = "@inheritdoc"

    end

    it_behaves_like "with member name parameter"

  end



  describe "@alias" do

    before do

      @tagname = "@alias"

    end

    it_behaves_like "with member name parameter"

  end



  describe "@inheritdoc without parameter" do

    before do

      @docs = parse(<<-EOF)