summaryrefslogtreecommitdiffstats
path: root/lib/puppet/util/inline_docs.rb
blob: 405b53945f2a7359007d0d398809493d9f5d4501 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
module Puppet::Util::InlineDocs
    def self.included(klass)
        klass.send(:include, InstanceMethods)
        klass.extend ClassMethods
    end

    module ClassMethods
        attr_accessor :use_docs
        def associates_doc
            self.use_docs = true
        end
    end

    module InstanceMethods
        attr_writer :doc

        def doc
            unless defined?(@doc) and @doc
                @doc = ""
            end
            @doc
        end

        # don't fetch lexer comment by default
        def use_docs
            self.class.use_docs
        end
    end
end