Skip to content

Commit

Permalink
Fixed Railtie Rdoc examples not properly formatted [#4918 state:resol…
Browse files Browse the repository at this point in the history
…ved]

Signed-off-by: Simone Carletti <weppos@weppos.net>
  • Loading branch information
weppos committed Aug 4, 2010
1 parent b3bb684 commit 7745f71
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions railties/lib/rails/railtie.rb
Expand Up @@ -6,53 +6,53 @@
module Rails
# Railtie is the core of the Rails Framework and provides several hooks to extend
# Rails and/or modify the initialization process.
#
#
# Every major component of Rails (Action Mailer, Action Controller,
# Action View, Active Record and Active Resource) are all Railties, so each of
# them is responsible to set their own initialization. This makes, for example,
# Rails absent of any Active Record hook, allowing any other ORM framework to hook in.
#
#
# Developing a Rails extension does _not_ require any implementation of
# Railtie, but if you need to interact with the Rails framework during
# or after boot, then Railtie is what you need to do that interaction.
#
#
# For example, the following would need you to implement Railtie in your
# plugin:
#
#
# * creating initializers
# * configuring a Rails framework or the Application, like setting a generator
# * adding Rails config.* keys to the environment
# * setting up a subscriber to the Rails +ActiveSupport::Notifications+
# * adding rake tasks into rails
#
#
# == Creating your Railtie
#
# Implementing Railtie in your Rails extension is done by creating a class
# Railtie that has your extension name and making sure that this gets loaded
# during boot time of the Rails stack.
#
#
# You can do this however you wish, but here is an example if you want to provide
# it for a gem that can be used with or without Rails:
#
#
# * Create a file (say, lib/my_gem/railtie.rb) which contains class Railtie inheriting from
# Rails::Railtie and is namespaced to your gem:
#
# # lib/my_gem/railtie.rb
# module MyGem
# class Railtie < Rails::Railtie
# # lib/my_gem/railtie.rb
# module MyGem
# class Railtie < Rails::Railtie
# end
# end
# end
#
#
# * Require your own gem as well as rails in this file:
#
# # lib/my_gem/railtie.rb
# require 'my_gem'
# require 'rails'
#
# module MyGem
# class Railtie < Rails::Railtie
#
# # lib/my_gem/railtie.rb
# require 'my_gem'
# require 'rails'
#
# module MyGem
# class Railtie < Rails::Railtie
# end
# end
# end
#
# == Initializers
#
Expand All @@ -65,7 +65,7 @@ module Rails
# end
# end
#
# If specified, the block can also receive the application object, in case you
# If specified, the block can also receive the application object, in case you
# need to access some application specific configuration, like middleware:
#
# class MyRailtie < Rails::Railtie
Expand Down

0 comments on commit 7745f71

Please sign in to comment.