diff options
| author | Brice Figureau <brice-puppet@daysofwonder.com> | 2010-10-16 17:47:50 +0200 |
|---|---|---|
| committer | James Turnbull <james@lovedthanlost.net> | 2010-11-10 05:56:45 +1100 |
| commit | 956296a74c701fee79d8eed898ce64da02c983de (patch) | |
| tree | 2cbaee1d4f53766a9bcdede36b8ea8a469d812b8 /lib/puppet | |
| parent | 4fa24bb4be7fd73af2a25884185f91b42f73d785 (diff) | |
| download | puppet-956296a74c701fee79d8eed898ce64da02c983de.tar.gz puppet-956296a74c701fee79d8eed898ce64da02c983de.tar.xz puppet-956296a74c701fee79d8eed898ce64da02c983de.zip | |
Fix #4911 - Do not generate doc for standard RDoc parser generated object
RDoc has some standard parsers for .c,.cc or fortran files (don't ask why).
Unfortunately our html generator doesn't support the data structures
generated by those parsers and we were bombing on unknown methods.
This patch makes sure we generate html only for our own top level objects.
Signed-off-by: Brice Figureau <brice-puppet@daysofwonder.com>
Diffstat (limited to 'lib/puppet')
| -rw-r--r-- | lib/puppet/util/rdoc/generators/puppet_generator.rb | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/puppet/util/rdoc/generators/puppet_generator.rb b/lib/puppet/util/rdoc/generators/puppet_generator.rb index 9caeacd5e..e6bbb2e1e 100644 --- a/lib/puppet/util/rdoc/generators/puppet_generator.rb +++ b/lib/puppet/util/rdoc/generators/puppet_generator.rb @@ -88,6 +88,12 @@ module Generators @modules = {} @allclasses = {} + # remove unknown toplevels + # it can happen that RDoc triggers a different parser for some files (ie .c, .cc or .h) + # in this case RDoc generates a RDoc::TopLevel which we do not support in this generator + # So let's make sure we don't generate html for those. + @toplevels = @toplevels.select { |tl| tl.is_a? RDoc::PuppetTopLevel } + # build the modules, classes and per modules classes and define list @toplevels.each do |toplevel| next unless toplevel.document_self |