From 999f65700d2f2a1e2457451b827cb7efe9042c4f Mon Sep 17 00:00:00 2001
From: Ben Dalling <b.dalling@locp.co.uk>
Date: Sat, 31 Dec 2016 10:35:40 +0000
Subject: [PATCH] Improved the inline documentation.

---
 manifests/init.pp   | 34 +++++++++++++++++++++++++++++++++-
 manifests/repo10.pp |  5 +++++
 manifests/repo9.pp  |  5 +++++
 3 files changed, 43 insertions(+), 1 deletion(-)

diff --git a/manifests/init.pp b/manifests/init.pp
index eca8e14..f8bf109 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -1,5 +1,37 @@
-# Class: odoo
 # Install and configure Odoo Community.
+#
+# @example Declaring the class with Odoo 10
+#   class { '::odoo':
+#     install_wkhtmltopdf => true,
+#     settings            => {
+#       'options' => {
+#         'admin_passwd' => 'XXX_TOP_SECRET_XXX',
+#         'db_host'      => 'False',
+#         'db_port'      => 'False',
+#         'db_user'      => 'odoo',
+#         'db_password'  => 'False',
+#         'addons_path'  => '/usr/lib/python2.7/dist-packages/odoo/addons',
+#       }
+#     },
+#     version             => present,
+#   }
+#
+# @example Declaring the class with Odoo 9
+#   class { '::odoo':
+#     install_wkhtmltopdf => true,
+#     settings            => {
+#       'options' => {
+#         'admin_passwd' => 'XXX_TOP_SECRET_XXX',
+#         'db_host'      => 'False',
+#         'db_port'      => 'False',
+#         'db_user'      => 'odoo',
+#         'db_password'  => 'False',
+#         'addons_path'  => '/usr/lib/python2.7/dist-packages/openerp/addons',
+#       }
+#     },
+#     version             => present,
+#   }
+#
 # @param config_file [string] The Odoo configuration file.  Will need to be
 #   changed to `/etc/odoo/openerp-server.conf` for Odoo 9.
 # @param install_wkhtmltopdf [boolean] Whether or not to install the optional
diff --git a/manifests/repo10.pp b/manifests/repo10.pp
index a059455..09d83d6 100644
--- a/manifests/repo10.pp
+++ b/manifests/repo10.pp
@@ -1,5 +1,10 @@
 # Install a repository to install an Odoo 10 package from.
 #
+# @example Declaring the class
+#   class { '::odoo::repo10':
+#     before => Class['odoo']
+#   }
+#
 # @param ensure [absent | present] Ensure the the repository is either
 #   absent or present.
 # @param descr [string] A string to describe the repository.
diff --git a/manifests/repo9.pp b/manifests/repo9.pp
index febb817..af9da4a 100644
--- a/manifests/repo9.pp
+++ b/manifests/repo9.pp
@@ -1,5 +1,10 @@
 # Install a repository to install an Odoo 9 package from.
 #
+# @example Declaring the class
+#   class { '::odoo::repo9':
+#     before => Class['odoo']
+#   }
+#
 # @param ensure [absent | present] Ensure the the repository is either
 #   absent or present.
 # @param descr [string] A string to describe the repository.