From 182ce60f7552ec62b1d97fbc3e701f9405b12291 Mon Sep 17 00:00:00 2001 From: drbrain Date: Wed, 12 Dec 2012 05:16:53 +0000 Subject: * 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 --- lib/rdoc/class_module.rb | 10 +++++++++- .../template/darkfish/_sidebar_table_of_contents.rhtml | 8 +++++++- lib/rdoc/generator/template/darkfish/table_of_contents.rhtml | 2 +- 3 files changed, 17 insertions(+), 3 deletions(-) (limited to 'lib/rdoc') diff --git a/lib/rdoc/class_module.rb b/lib/rdoc/class_module.rb index e2bb9de68d..a520503598 100644 --- a/lib/rdoc/class_module.rb +++ b/lib/rdoc/class_module.rb @@ -184,7 +184,7 @@ class RDoc::ClassModule < RDoc::Context # Appends +comment+ to the current comment, but separated by a rule. Works # more like +=. - 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. diff --git a/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml b/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml index 225f811f0e..7842625840 100644 --- a/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +++ b/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml @@ -1,4 +1,10 @@ -<% table = current.parse(current.comment).table_of_contents +<% comment = if current.respond_to? :comment_location then + current.comment_location + else + current.comment + end + table = current.parse(comment).table_of_contents + if table.length > 1 then %>