Class: YARD::Handlers::C::InitHandler
- Defined in:
- lib/yard/handlers/c/init_handler.rb
Overview
Handles the Init_Libname() method
Constant Summary
- MATCH =
%r{\A\s*(?:static\s+)?void\s+(?:[Ii]nit_)?(\w+)\s*}
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 HandlerMethods
#handle_alias, #handle_attribute, #handle_class, #handle_constants, #handle_method, #handle_module
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
7 8 9 10 11 12 13 14 15 16 17 |
# File 'lib/yard/handlers/c/init_handler.rb', line 7 process do parse_block if decl = statement.declaration[MATCH, 1] ns = namespace_for_variable(decl) if ns.is_a?(YARD::CodeObjects::NamespaceObject) && ns.docstring.blank? if statement.comments register_docstring(ns, statement.comments.source, statement) end end end end |