I am using Ruby on Rails 3.0.7 and I am writing some documentation for my application using RDoc. In my application file I have this:
#[EXAMPLE 1 - Some text.]
#
# [CASE 1 - Some text.]
#
# class User < ActiveRecord::Base
# has_many :account,
# :class_name => 'User::Account',
# :foreign_key => 'account_id'
# end
On generating documentation for my application the above commented code will leave class User < ActiveRecord::Base
and end
parts outside the paragraph block where those should appear.
The following is the related screen shot:
How can I solve that?
I get the same output (outside the paragraph block where the class statement should appear) if I use this
#[Example 1 - Some text.]
#
# class User < ActiveRecord::Base
# has_many :account,
# :class_name => 'User::Account',
# :foreign_key => 'account_id'
# end
or this
#class User < ActiveRecord::Base
# has_many :account,
# :class_name => 'User::Account',
# :foreign_key => 'account_id'
#end