Lots of work related to generating more reference. Moving all of the individual references out of puppetdoc and into an external "reference" class, which itself can autoload, so it is now easy to add new types of references. Also adding a network reference, along with an unfinished provider reference.

git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2479 980ebf18-57e1-0310-9a29-db15c13687c0

1 files changed, 12 insertions, 0 deletions

diff --git a/lib/puppet/network/handler/resource.rb b/lib/puppet/network/handler/resource.rb
index 2937aa7be..349f73537 100755
--- a/lib/puppet/network/handler/resource.rb
+++ b/lib/puppet/network/handler/resource.rb
@@ -4,6 +4,16 @@ require 'puppet/network/handler'
 # Serve Puppet elements.  Useful for querying, copying, and, um, other stuff.
 class Puppet::Network::Handler
     class Resource < Handler
+        desc "An interface for interacting with client-based resources that can
+        be used for querying or managing remote machines without using Puppet's
+        central server tools.
+        
+        The ``describe`` and ``list`` methods return TransBuckets containing
+        TransObject instances (``describe`` returns a single TransBucket),
+        and the ``apply`` method accepts a TransBucket of TransObjects and
+        applies them locally.
+        "
+
         attr_accessor :local
 
         @interface = XMLRPC::Service::Interface.new("resource") { |iface|
@@ -12,6 +22,8 @@ class Puppet::Network::Handler
             iface.add_method("string list(string, array, string)")
         }
 
+        side :client
+
         # Apply a TransBucket as a transaction.
         def apply(bucket, format = "yaml", client = nil, clientip = nil)
             unless @local