Mark implementation-oriented classes and methods in the javasupport with :nodoc:
--------------------------------------------------------------------------------
Key: JRUBY-1473
URL: http://jira.codehaus.org/browse/JRUBY-1473
Project: JRuby
Issue Type: Bug
Affects Versions: JRuby 1.0.1
Reporter: Tor Norbye
Assignee: Thomas E Enebo
The Ruby files in builtin/java/ contain a number of classes and method
extensions which adds Java integration to Ruby.
Some of these methods are clearly intended to be used by users - such as
Module.import. However, a lot of the classes appear to be part of the runtime
machinery to make integration work.
It would be great if these could be marked as :nodoc: to make the documentation
simpler and clearer. (Perhaps some of these can actually be marked protected
and private too?)
Adding :nodoc: to things believed to be implementation-only is low risk so it
would be great if this could be applied to the 1.0.2 branch as well.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe from this list please visit:
http://xircles.codehaus.org/manage_email
