method

signature

v2_6_3 - Show latest stable - Class: RDoc::TomDoc

signature(comment)

public

Internal: Extracts the Signature section’s method signature

comment - An RDoc::Comment that will be parsed and have the signature

extracted

Returns a String containing the signature and nil if not

# File lib/rdoc/tom_doc.rb, line 100
  def self.signature comment
    return unless comment.tomdoc?

    document = comment.parse

    signature = nil
    found_heading = false
    found_signature = false

    document.parts.delete_if do |part|
      next false if found_signature

      found_heading ||=
        RDoc::Markup::Heading === part && part.text == 'Signature'

      next false unless found_heading

      next true if RDoc::Markup::BlankLine === part

      if RDoc::Markup::Verbatim === part then
        signature = part
        found_signature = true
      end
    end

    signature and signature.text
  end

signature

Related methods