class documentation

Signed-off-by: Stephen Gran <steve@lobefin.net>

diff --git a/modules/roles/manifests/pubsub/entities.pp b/modules/roles/manifests/pubsub/entities.pp
index d728612..acbc173 100644 (file)
--- a/modules/roles/manifests/pubsub/entities.pp
+++ b/modules/roles/manifests/pubsub/entities.pp
@@ -1,3 +1,11 @@
+# = Class: roles::pubsub::entities
+#
+# MQ users, vhosts, policies, and permissions for pubsub hosts
+#
+# == Sample Usage:
+#
+#   include roles::pubsub::entities
+#
 class roles::pubsub::entities {
        include roles::pubsub::params