blob: ebbce731763fb8dbb1a8e2c5180d19740ce89c7c (
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
# Some simple methods for helping manage automatic documentation generation.
module Puppet::Util::Docs
# Specify the actual doc string.
def desc(str)
@doc = str
end
# Add a new autodoc block. We have to define these as class methods,
# rather than just sticking them in a hash, because otherwise they're
# too difficult to do inheritance with.
def dochook(name, &block)
method = "dochook_" + name.to_s
meta_def method, &block
end
# Generate the full doc string.
def doc
extra = methods.find_all { |m| m.to_s =~ /^dochook_.+/ }.collect { |m|
self.send(m)
}.join(" ")
if defined? @doc and @doc
@doc + extra
else
extra
end
end
# Handle the inline indentation in the docs.
def scrub(text)
# Stupid markdown
#text = text.gsub("<%=", "<%=")
# For text with no carriage returns, there's nothing to do.
if text !~ /\n/
return text
end
indent = nil
# If we can match an indentation, then just remove that same level of
# indent from every line.
if text =~ /^(\s+)/
indent = $1
begin
return text.gsub(/^#{indent}/,'')
rescue => detail
puts detail.backtrace
puts detail
end
else
return text
end
end
module_function :scrub
end
# $Id$
|
