Class: YARD::Handlers::Ruby::CommentHandler

Inherits:

Base

• Object
• Base
• Base
• YARD::Handlers::Ruby::CommentHandler

Defined in:

lib/yard/handlers/ruby/comment_handler.rb

Overview

Handles any lone comment statement in a Ruby file

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 Parser::Ruby

#s

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/comment_handler.rb', line 6

process do
  register_docstring(nil)
end