class PuppetStrings::Markdown::Base

This class makes elements in a YARD::Registry hash easily accessible for templates.

Here’s an example hash: {:name=>:klass, :file=>“(stdin)”, :line=>16, :inherits=>“foo::bar”, :docstring=>

{:text=>"An overview for a simple class.",
 :tags=>
  [{:tag_name=>"summary", :text=>"A simple class."},
   {:tag_name=>"since", :text=>"1.0.0"},
   {:tag_name=>"see", :name=>"www.puppet.com"},
   {:tag_name=>"deprecated", :text=>"No longer supported and will be removed in a future release"},
   {:tag_name=>"example",
    :text=>
     "class { 'klass':\n" +
     "  param1 => 1,\n" +
     "  param3 => 'foo',\n" +
     "}",
    :name=>"This is an example"},
   {:tag_name=>"author", :text=>"eputnam"},
   {:tag_name=>"option", :name=>"opts"},
   {:tag_name=>"raise", :text=>"SomeError"},
   {:tag_name=>"param",
    :text=>"First param.",
    :types=>["Integer"],
    :name=>"param1"},
   {:tag_name=>"param",
    :text=>"Second param.",
    :types=>["Any"],
    :name=>"param2"},
   {:tag_name=>"param",
    :text=>"Third param.",
    :types=>["String"],
    :name=>"param3"}]},

:defaults=>{“param1”=>“1”, “param2”=>“undef”, “param3”=>“‘hi’”}, :source=>

"class klass (\n" +
"  Integer $param1 = 1,\n" +
"  $param2 = undef,\n" +
"  String $param3 = 'hi'\n" +
") inherits foo::bar {\n" +
"}"}