From: James Edward Gray II <james@...>
Date: 2004-10-27T03:17:58+09:00
Subject: Questions About Documenting erb.rb

I'm currently trying to document erb.rb and this is my first big foray 
into RDoc land.  erb.rb has code like this:

class ERB
	# ...
end

class ERB
	# ...
end

class ERB
	# ...
end

As near as I can determine, RDoc picks up the comment before the FINAL 
class definition to use in the documentation.  Here are my questions 
about that:

1.  Can I override this somehow?  It seems odd to me to shove all the 
documentation down to almost the bottom of the source.

2.  As a documentation writer, I assume my job is to affect the 
original source as little as humanly possible.  (I'm even trying very 
hard to preserve the few comments that are there, though they aren't 
documentation material.)  Given this, is a switch to:

class ERB
	# ...

	# ...

	# ...
end

overstepping my role?  I don't feel right about it, but I would like to 
hear the opinions of others.

(Note:  I do not believe the above would affect erb.rb syntax in any 
way.  Please correct me if I'm wrong!)

Thanks.

James Edward Gray II