Contents

module Inch
  module Evaluation
    module Role
      module Object
        class WithDoc < Base
        end
        class WithoutDoc < Missing
          def suggestion
            "Add a comment describing the #{object_type}"
          end
        end

        # Tagged means tagged in an unconsidred way, i.e. YARD tags not
        # considered by Inch. Since these tags are parsed from the docstring
        # the object seems undocumented to Inch.
        class Tagged < Base
          def priority
            -1
          end
        end
        class TaggedAsNodoc < Base
          def priority
            -7
          end
        end
        class InRoot < Base
          def priority
            +3
          end
        end

        class Public < Base
          def priority
            if object.type == :constant
              -1
            else
              +2
            end
          end
        end
        class Protected < Base
          def priority
            +1
          end
        end
        class Private < Base
          def priority
            -2
          end
        end

        class WithCodeExample < Base
        end
        class WithMultipleCodeExamples < Base
        end
        class WithoutCodeExample < Missing
          def suggestion
            "Add a code example (optional)"
          end
        end
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
inch-0.1.3	lib/inch/evaluation/role/object.rb
inch-0.1.2	lib/inch/evaluation/role/object.rb
inch-0.1.1	lib/inch/evaluation/role/object.rb
inch-0.1.0	lib/inch/evaluation/role/object.rb