1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

* lib/rdoc/class_module.rb: Added RDoc::ClassModule#documented? which

checks comment_location.  Hide RDoc::ClassModule#comment=.
* test/rdoc/test_rdoc_class_module.rb:  Test for above.

* lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml:
  Fix display of the table of contents in the sidebar.

* lib/rdoc/generator/template/darkfish/table_of_contents.rhtml:
  Use #comment_location when displaying classes or modules.

* test/rdoc/test_rdoc_store.rb:  Use comment_location.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38338 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
drbrain 2012-12-12 05:16:53 +00:00
parent f92db3dd73
commit 182ce60f75
6 changed files with 54 additions and 4 deletions

View file

@ -184,7 +184,7 @@ class RDoc::ClassModule < RDoc::Context
# Appends +comment+ to the current comment, but separated by a rule. Works
# more like <tt>+=</tt>.
def comment= comment
def comment= comment # :nodoc:
comment = case comment
when RDoc::Comment then
comment.normalize
@ -216,6 +216,14 @@ class RDoc::ClassModule < RDoc::Context
document_self || method_list.any?{ |m| m.document_self }
end
##
# Does this class or module have a comment with content or is
# #received_nodoc true?
def documented?
super or !@comment_location.empty?
end
##
# Iterates the ancestors of this class or module for which an
# RDoc::ClassModule exists.