Commit 3de8f40a authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Turn @ignore into builtin Tag class.

parent d8da577c
Loading
Loading
Loading
Loading
+2 −2
Original line number Diff line number Diff line
@@ -120,7 +120,7 @@ module JsDuck
    # When no class precedes them - they too are orphaned.
    def add_member(node)
      # Completely ignore member if @ignore used
      return if node[:meta][:ignore]
      return if node[:ignore]

      if node[:owner]
        if @classes[node[:owner]]
@@ -197,7 +197,7 @@ module JsDuck
    # Gets rid of classes marked with @ignore
    def remove_ignored_classes
      @documentation.delete_if do |cls|
        if cls[:meta][:ignore]
        if cls[:ignore]
          @classes.delete(cls["name"])
          true
        end
+12 −0
Original line number Diff line number Diff line
require "jsduck/builtins/boolean_tag"

module JsDuck::Builtins
  # Causes a member or entire class documentation to be completely
  # excluded from docs.
  class Ignore < BooleanTag
    def initialize
      @key = :ignore
      super
    end
  end
end

lib/jsduck/tag/ignore.rb

deleted100644 → 0
+0 −13
Original line number Diff line number Diff line
require "jsduck/meta_tag"

module JsDuck::Tag
  # @ignore is alias for @private
  class Ignore < JsDuck::MetaTag
    def initialize
      @name = "ignore"
      @key = :ignore
      @boolean = true
    end
  end
end