Module: RDoc::AddClassModuleComment Private

Included in:
PuppetClass, PuppetModule, PuppetNode
Defined in:
lib/puppet/util/rdoc/code_objects.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Add top level comments to a class or module regardless of whether we are using rdoc1 or rdoc2+

Instance Method Summary collapse

Instance Method Details

#add_comment(comment, location = nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



20
21
22
23
24
25
26
 
# File 'lib/puppet/util/rdoc/code_objects.rb', line 20

def add_comment(comment, location = nil)
  if PUPPET_RDOC_VERSION == 1
    self.comment = comment
  else
    super
  end
end