Class RDoc::Context::Section
In: rdoc/code_objects.rb
Parent: Object

Contents

Methods

new  

Attributes

comment  [R] 
sequence  [R] 
title  [R] 

Public Class methods

new(title, comment)

[Source]

# File rdoc/code_objects.rb, line 125
      def initialize(title, comment)
        @title = title
        @@sequence.succ!
        @sequence = @@sequence.dup
        set_comment(comment)
      end

The title

remove lines up to the line containing :section:, and look for those lines again at the end and remove them. This lets us write 

  # ---------------------
  # :SECTION: The title
  # The body
  # ---------------------

ruby-doc.org is hosted and maintained by James Britt and Happy Camper Studios, a Ruby application development company in Phoenix, Arizona. The site was created in 2002 as part of the Ruby Documentation Project to promote the Ruby language and to help other Ruby hackers.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.