diff options
author | luke <luke@980ebf18-57e1-0310-9a29-db15c13687c0> | 2005-09-02 20:12:15 +0000 |
---|---|---|
committer | luke <luke@980ebf18-57e1-0310-9a29-db15c13687c0> | 2005-09-02 20:12:15 +0000 |
commit | 3fb6f49dc8d1a501ed2f4fd52c247ae2a95d8460 (patch) | |
tree | 13f0a0cf78ca91626e1a135d523aa1922d923e8c | |
parent | 75ec0543d27f3c552a778adae3255a3cb68f918b (diff) | |
download | puppet-3fb6f49dc8d1a501ed2f4fd52c247ae2a95d8460.tar.gz puppet-3fb6f49dc8d1a501ed2f4fd52c247ae2a95d8460.tar.xz puppet-3fb6f49dc8d1a501ed2f4fd52c247ae2a95d8460.zip |
rearranging puppetdoc to not separate states and parameters, and to allow undocumented states
git-svn-id: https://reductivelabs.com/svn/puppet/trunk@623 980ebf18-57e1-0310-9a29-db15c13687c0
-rwxr-xr-x | bin/puppetdoc | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/bin/puppetdoc b/bin/puppetdoc index 4a7693be7..fc5d13c1a 100755 --- a/bin/puppetdoc +++ b/bin/puppetdoc @@ -133,25 +133,35 @@ types.sort { |a,b| puts type.doc.gsub(/\n\s*/, ' ') + "\n\n" type.buildstatehash #puts tab(1) + "* namevar: %s" % type.namevar - puts "%s States\n'''''''''''''''''''''''''''''''" % name.to_s.capitalize + docs = {} + #puts "%s States\n'''''''''''''''''''''''''''''''" % name.to_s.capitalize type.validstates.sort { |a,b| a.to_s <=> b.to_s + }.reject { |sname,state| + state.nodoc }.each { |sname,state| - puts "- **%s**" % sname - puts tab(1) + state.doc.gsub(/\n\s*/,' ') + docs[sname] = state.doc.gsub(/\n\s*/,' ') + #puts "- **%s**" % sname + #puts tab(1) + state.doc.gsub(/\n\s*/,' ') } puts "\n%s Parameters\n''''''''''''''''''''''''''''''" % name.to_s.capitalize type.parameters.sort { |a,b| a.to_s <=> b.to_s }.each { |name,param| + docs[name] = type.paramdoc(name).gsub(/\n\s*/,' ') + } + + docs.sort { |a, b| + a[0].to_s <=> b[0].to_s + }.each { |name, doc| print "- **%s**" % name if type.namevar == name and name != :name puts " (*namevar*)" else puts "" end - puts tab(1) + type.paramdoc(name).gsub(/\n\s*/,' ') + puts tab(1) + doc } puts "\n" } |