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

Include protected members to documentation. 

Visually marking them as protected with label similar to deprecated.
parent 58ab309e

lib/jsduck/aggregator.rb

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


    # Merges new class-doc into old one.

    def merge_classes(old, new)

      [:extends, :xtype, :singleton, :private].each do |tag|

      [:extends, :xtype, :singleton, :private, :protected].each do |tag|

        old[tag] = old[tag] || new[tag]

      end

      [:mixins, :alternateClassNames, :xtypes].each do |tag|

lib/jsduck/doc_parser.rb

+4 −2
Original line number Diff line number Diff line
@@ -111,8 +111,10 @@ module JsDuck 
          at_var

        elsif look(/@static\b/)

          boolean_at_tag(/@static/, :static)

        elsif look(/@(private|ignore|hide|protected)\b/)

          boolean_at_tag(/@(private|ignore|hide|protected)/, :private)

        elsif look(/@(private|ignore|hide)\b/)

          boolean_at_tag(/@(private|ignore|hide)/, :private)

        elsif look(/@protected\b/)

          boolean_at_tag(/@protected/, :protected)

        elsif look(/@markdown\b/)

          # this is detected just to be ignored

          boolean_at_tag(/@markdown/, :markdown)

lib/jsduck/merger.rb

+7 −0
Original line number Diff line number Diff line
@@ -126,6 +126,7 @@ module JsDuck 
        :docauthor => detect_docauthor(doc_map),

        :singleton => !!doc_map[:singleton],

        :private => !!doc_map[:private],

        :protected => !!doc_map[:protected],

      }

    end
@@ -139,6 +140,7 @@ module JsDuck 
        :params => detect_params(docs, code),

        :return => detect_return(doc_map),

        :private => !!doc_map[:private],

        :protected => !!doc_map[:protected],

        :static => !!doc_map[:static],

        :deprecated => detect_deprecated(doc_map),

      }
@@ -153,6 +155,7 @@ module JsDuck 
        :doc => detect_doc(docs),

        :params => detect_params(docs, code),

        :private => !!doc_map[:private],

        :protected => !!doc_map[:protected],

        :deprecated => detect_deprecated(doc_map),

      }

    end
@@ -166,6 +169,7 @@ module JsDuck 
        :type => detect_type(:cfg, doc_map, code),

        :doc => detect_doc(docs),

        :private => !!doc_map[:private],

        :protected => !!doc_map[:protected],

        :deprecated => detect_deprecated(doc_map),

      }

    end
@@ -179,6 +183,7 @@ module JsDuck 
        :type => detect_type(:property, doc_map, code),

        :doc => detect_doc(docs),

        :private => !!doc_map[:private],

        :protected => !!doc_map[:protected],

        :static => !!doc_map[:static],

        :deprecated => detect_deprecated(doc_map),

      }
@@ -193,6 +198,7 @@ module JsDuck 
        :type => detect_type(:css_var, doc_map, code),

        :doc => detect_doc(docs),

        :private => !!doc_map[:private],

        :protected => !!doc_map[:protected],

        :static => !!doc_map[:static],

        :deprecated => detect_deprecated(doc_map),

      }
@@ -207,6 +213,7 @@ module JsDuck 
        :doc => detect_doc(docs),

        :params => detect_params(docs, code),

        :private => !!doc_map[:private],

        :protected => !!doc_map[:protected],

        :static => !!doc_map[:static],

        :deprecated => detect_deprecated(doc_map),

      }

spec/aggregator_private_spec.rb

+7 −2
Original line number Diff line number Diff line
@@ -35,8 +35,13 @@ describe JsDuck::Aggregator do 
  end



  describe "@protected" do

    before { @tagname = "@protected" }

    it_should_behave_like "private"

    before do

      @doc = parse("/**\n * @protected\n */")[0]

    end



    it "marks item as protected" do

      @doc[:protected].should == true

    end

  end



end

template/app/view/cls/Overview.js

+3 −0
Original line number Diff line number Diff line
@@ -220,6 +220,9 @@ Ext.define('Docs.view.cls.Overview', { 
            }

        }



        if (member.protected) {

            signature += "<strong class='protected-signature'>protected</strong>";

        }

        if (member.deprecated) {

            signature += "<strong class='deprecated-signature'>deprecated</strong>";

        }