Class: YARD::Handlers::Ruby::PrivateClassMethodHandler

Inherits:

Base

• Object
• Base
• Base
• YARD::Handlers::Ruby::PrivateClassMethodHandler

Includes:

DecoratorHandlerMethods

Defined in:

lib/yard/handlers/ruby/private_class_method_handler.rb

Overview

Sets visibility of a class method to private.

Constant Summary

Constants included from CodeObjects

CodeObjects::BUILTIN_ALL, CodeObjects::BUILTIN_CLASSES, CodeObjects::BUILTIN_EXCEPTIONS, CodeObjects::BUILTIN_EXCEPTIONS_HASH, CodeObjects::BUILTIN_MODULES, CodeObjects::CONSTANTMATCH, CodeObjects::CONSTANTSTART, CodeObjects::CSEP, CodeObjects::CSEPQ, CodeObjects::ISEP, CodeObjects::ISEPQ, CodeObjects::METHODMATCH, CodeObjects::METHODNAMEMATCH, CodeObjects::NAMESPACEMATCH, CodeObjects::NSEP, CodeObjects::NSEPQ

Instance Method Summary

• #process ⇒ void

  Main processing callback.

Methods included from DecoratorHandlerMethods

#process_decorator

Methods included from Parser::Ruby

#s

Methods included from CodeObjects::NamespaceMapper

#clear_separators, #default_separator, on_invalidate, #register_separator, #separators, #separators_for_type, #separators_match, #types_for_separator, #unregister_separator_by_type

Constructor Details

This class inherits a constructor from YARD::Handlers::Base

Instance Method Details

#process ⇒ void

This method returns an undefined value.

Main processing callback

# File 'lib/yard/handlers/ruby/private_class_method_handler.rb', line 9

process do
  process_decorator :scope => :class do |method|
    method.visibility = :private if method.respond_to? :visibility=
  end
end