Commit 77df0390 authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Merge pull request #127 from rdougan/removing-evented-docs 

Removing incorrect docs from @evented tag
parents f3ebe45b 995c7c81

lib/jsduck/accessors.rb

+1 −6
Original line number Diff line number Diff line
@@ -83,12 +83,7 @@ module JsDuck 
      return add_shared({

        :tagname => :event,

        :name => name,

        :doc =>

          "Fires when the {@link ##{cfg[:id]}} configuration is changed by {@link #method-#{setter_name}}." +

          "\n\n" +

          "Note that this event is fired *before* the value of {@link ##{cfg[:id]}} has been updated, " +

          "and that you can return false from any listener to the #{name} event " +

          "to cancel the change.",

        :doc => "Fires when the {@link ##{cfg[:id]}} configuration is changed by {@link #method-#{setter_name}}.",

        :params => [

          {

            :name => "this",

spec/aggregator_accessors_spec.rb

+1 −4
Original line number Diff line number Diff line
@@ -170,10 +170,7 @@ describe JsDuck::Aggregator do 


    it "creates documentation for foochange event" do

      @events[0][:doc].should ==

        "Fires when the {@link #cfg-foo} configuration is changed by {@link #method-setFoo}.\n\n" +

        "Note that this event is fired *before* the value of {@link #cfg-foo} has been updated, " +

        "and that you can return false from any listener to the foochange event " +

        "to cancel the change."

        "Fires when the {@link #cfg-foo} configuration is changed by {@link #method-setFoo}."

    end



    it "has 3 params" do