Class: Generators::HTMLPuppetResource

Inherits:
Object
  • Object
show all
Includes:
MarkUp
Defined in:
lib/puppet/util/rdoc/generators/puppet_generator.rb

Constant Summary collapse

@@seq =
"R000000"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MarkUp

#new_markup

Constructor Details

#initialize(context, html_class, options) ⇒ HTMLPuppetResource

Returns a new instance of HTMLPuppetResource.



824
825
826
827
828
829
830
831
832
833
834
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 824

def initialize(context, html_class, options)
  @context    = context
  @html_class = html_class
  @options    = options
  @@seq       = @@seq.succ
  @seq        = @@seq

  context.viewer = self

  AllReferences.add(name, self)
end

Instance Attribute Details

#contextObject (readonly)

Returns the value of attribute context.



820
821
822
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 820

def context
  @context
end

Instance Method Details

#<=>(other) ⇒ Object



884
885
886
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 884

def <=>(other)
  @context <=> other.context
end

#arefObject



868
869
870
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 868

def aref
  @seq
end

#as_href(from_path) ⇒ Object



836
837
838
839
840
841
842
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 836

def as_href(from_path)
  if @options.all_one_file
    "##{path}"
  else
    HTMLGenerator.gen_url(from_path, path)
  end
end

#descriptionObject



880
881
882
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 880

def description
  markup(@context.comment)
end

#document_selfObject



888
889
890
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 888

def document_self
  @context.document_self
end

#find_symbol(symbol, method = nil) ⇒ Object



892
893
894
895
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 892

def find_symbol(symbol, method = nil)
  res = @context.parent.find_symbol(symbol, method)
  res && res.viewer
end

#index_nameObject



852
853
854
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 852

def index_name
  "#{@context.name}"
end

#nameObject



844
845
846
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 844

def name
  @context.name
end

#paramsObject



856
857
858
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 856

def params
  @context.params
end

#parent_nameObject



860
861
862
863
864
865
866
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 860

def parent_name
  if @context.parent.parent
    @context.parent.parent.full_name
  else
    nil
  end
end

#pathObject



872
873
874
875
876
877
878
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 872

def path
  if @options.all_one_file
    aref
  else
    @html_class.path + "##{aref}"
  end
end

#sectionObject



848
849
850
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 848

def section
  @context.section
end