Skip to content

Commit

Permalink
Improved the inline documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
dallinb committed Dec 31, 2016
1 parent cc6d898 commit 999f657
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 1 deletion.
34 changes: 33 additions & 1 deletion manifests/init.pp
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 5 additions & 0 deletions manifests/repo10.pp
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
5 changes: 5 additions & 0 deletions manifests/repo9.pp
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 999f657

Please sign in to comment.