class Generators::HTMLPuppetResource

Attributes

context[R]

Public Class Methods

new(context, html_class, options) click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
831 def initialize(context, html_class, options)
832   @context    = context
833   @html_class = html_class
834   @options    = options
835   @@seq       = @@seq.succ
836   @seq        = @@seq
837 
838   context.viewer = self
839 
840   AllReferences.add(name, self)
841 end

Public Instance Methods

<=>(other) click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
891 def <=>(other)
892   @context <=> other.context
893 end
aref() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
875 def aref
876   @seq
877 end
as_href(from_path) click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
843 def as_href(from_path)
844   if @options.all_one_file
845     "##{path}"
846   else
847     HTMLGenerator.gen_url(from_path, path)
848   end
849 end
description() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
887 def description
888   markup(@context.comment)
889 end
document_self() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
895 def document_self
896   @context.document_self
897 end
find_symbol(symbol, method=nil) click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
899 def find_symbol(symbol, method=nil)
900   res = @context.parent.find_symbol(symbol, method)
901   res && res.viewer
902 end
index_name() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
859 def index_name
860   "#{@context.name}"
861 end
name() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
851 def name
852   @context.name
853 end
params() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
863 def params
864   @context.params
865 end
parent_name() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
867 def parent_name
868   if @context.parent.parent
869     @context.parent.parent.full_name
870   else
871     nil
872   end
873 end
path() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
879 def path
880   if @options.all_one_file
881     aref
882   else
883     @html_class.path + "##{aref}"
884   end
885 end
section() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
855 def section
856   @context.section
857 end