Class: YARD::Handlers::Ruby::PrivateClassMethodHandler
- Defined in:
- lib/yard/handlers/ruby/private_class_method_handler.rb
Overview
Sets visibility of a class method
Constant Summary
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 Attribute Summary collapse
-
#extra_state ⇒ Object
inherited
from Base
readonly
Returns the value of attribute extra_state.
-
#globals ⇒ Object
inherited
from Base
readonly
Returns the value of attribute globals.
-
#namespace ⇒ Object
inherited
from Base
Returns the value of attribute namespace.
-
#owner ⇒ Object
inherited
from Base
Returns the value of attribute owner.
-
#parser ⇒ Processor
inherited
from Base
readonly
The processor object that manages all global state during handling.
-
#scope ⇒ Object
inherited
from Base
Returns the value of attribute scope.
-
#statement ⇒ Object
inherited
from Base
readonly
The statement object currently being processed.
-
#visibility ⇒ Object
inherited
from Base
Returns the value of attribute visibility.
Instance Method Summary collapse
-
#process ⇒ void
Main processing callback.
Methods included from Parser::Ruby
Constructor Details
This class inherits a constructor from YARD::Handlers::Base
Instance Attribute Details
#extra_state ⇒ Object (readonly) Originally defined in class Base
Returns the value of attribute extra_state
#globals ⇒ Object (readonly) Originally defined in class Base
Returns the value of attribute globals
#namespace ⇒ Object Originally defined in class Base
Returns the value of attribute namespace
#owner ⇒ Object Originally defined in class Base
Returns the value of attribute owner
#parser ⇒ Processor (readonly) Originally defined in class Base
Returns the processor object that manages all global state during handling.
#scope ⇒ Object Originally defined in class Base
Returns the value of attribute scope
#statement ⇒ Object (readonly) Originally defined in class Base
Returns the statement object currently being processed. Usually refers to one semantic language statement, though the strict definition depends on the parser used.
#visibility ⇒ Object Originally defined in class Base
Returns the value of attribute visibility
Instance Method Details
#process ⇒ void
This method returns an undefined value.
Main processing callback
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
# File 'lib/yard/handlers/ruby/private_class_method_handler.rb', line 6 process do errors = [] statement.parameters.each do |param| next unless AstNode === param begin privatize_class_method(param) rescue UndocumentableError => err errors << err. end end if errors.size > 0 msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}" raise UndocumentableError, "private class_method#{msg} for #{namespace.path}" end end |