Commit 76199d0f authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Disable no-doc warnings for params by default. 

Break the no_doc warning type into three:

- no_doc
- no_doc_member
- no_doc_param
parent 4baa2918

lib/jsduck/logger.rb

+3 −1
Original line number Diff line number Diff line
@@ -32,7 +32,9 @@ module JsDuck 


        [:alt_name, "Name used as both classname and alternate classname"],

        [:name_missing, "Member or parameter has no name"],

        [:no_doc, "Public class or member without documentation"],

        [:no_doc, "Public class without documentation"],

        [:no_doc_member, "Public member without documentation"],

        [:no_doc_param, "Parameter of public member without documentation"],

        [:dup_param, "Method has two parameters with the same name"],

        [:dup_member, "Class has two members with the same name"],

        [:req_after_opt, "Required parameter comes after optional"],

lib/jsduck/options.rb

+2 −1
Original line number Diff line number Diff line
@@ -139,11 +139,12 @@ module JsDuck 
      # Turn multiprocessing off by default in Windows

      Util::Parallel.in_processes = Util::OS::windows? ? 0 : nil



      # enable all warnings except :link_auto

      # Enable all warnings except the following:

      Logger.set_warning(:all, true)

      Logger.set_warning(:link_auto, false)

      Logger.set_warning(:param_count, false)

      Logger.set_warning(:fires, false)

      Logger.set_warning(:no_doc_param, false)



      @optparser = create_option_parser

    end

lib/jsduck/process/lint.rb

+2 −2
Original line number Diff line number Diff line
@@ -48,12 +48,12 @@ module JsDuck 
          cls.all_local_members.each do |member|

            if !member[:private] && !member[:hide] && !JsDuck::Class.constructor?(member)

              if member[:doc] == ""

                warn(:no_doc, "No documentation for #{member[:owner]}##{member[:name]}", member)

                warn(:no_doc_member, "No documentation for #{member[:owner]}##{member[:name]}", member)

              end



              (member[:params] || []).each do |p|

                if p[:doc] == ""

                  warn(:no_doc, "No documentation for parameter #{p[:name]} of #{member[:owner]}##{member[:name]}", member)

                  warn(:no_doc_param, "No documentation for parameter #{p[:name]} of #{member[:owner]}##{member[:name]}", member)

                end

              end