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
832 def initialize(context, html_class, options)
833   @context    = context
834   @html_class = html_class
835   @options    = options
836   @@seq       = @@seq.succ
837   @seq        = @@seq
838 
839   context.viewer = self
840 
841   AllReferences.add(name, self)
842 end

Public Instance Methods

<=>(other) click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
892 def <=>(other)
893   @context <=> other.context
894 end

aref() click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
876 def aref
877   @seq
878 end

as_href(from_path) click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
844 def as_href(from_path)
845   if @options.all_one_file
846     "##{path}"
847   else
848     HTMLGenerator.gen_url(from_path, path)
849   end
850 end

description() click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
888 def description
889   markup(@context.comment)
890 end

document_self() click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
896 def document_self
897   @context.document_self
898 end

find_symbol(symbol, method=nil) click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
900 def find_symbol(symbol, method=nil)
901   res = @context.parent.find_symbol(symbol, method)
902   res && res.viewer
903 end

index_name() click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
860 def index_name
861   "#{@context.name}"
862 end

name() click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
852 def name
853   @context.name
854 end

params() click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
864 def params
865   @context.params
866 end

parent_name() click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
868 def parent_name
869   if @context.parent.parent
870     @context.parent.parent.full_name
871   else
872     nil
873   end
874 end

path() click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
880 def path
881   if @options.all_one_file
882     aref
883   else
884     @html_class.path + "##{aref}"
885   end
886 end

section() click to toggle source

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
856 def section
857   @context.section
858 end