switch to puppet strings documentation layout for manifests

Author: crazymind1337

Diff for: REFERENCE.md

@@ -1,45 +1,36 @@
-# == Class: docker::compose
+# @summary install Docker Compose using the recommended curl command.
 #
-# Class to install Docker Compose using the recommended curl command.
-#
-# === Parameters
-#
-# [*ensure*]
+# @param ensure
 #   Whether to install or remove Docker Compose
 #   Valid values are absent present
-#   Defaults to present
 #
-# [*version*]
+# @param version
 #   The version of Docker Compose to install.
-#   Defaults to the value set in $docker::params::compose_version
 #
-# [*install_path*]
+# @param install_path
 #   The path where to install Docker Compose.
-#   Defaults to the value set in $docker::params::compose_install_path
 #
-# [*symlink_name*]
+# @param symlink_name
 #   The name of the symlink created pointing to the actual docker-compose binary
 #   This allows use of own docker-compose wrapper scripts for the times it's
 #   necessary to set certain things before running the docker-compose binary
-#   Defaults to the value set in $docker::params::compose_symlink_name
 #
-# [*proxy*]
+# @param proxy
 #   Proxy to use for downloading Docker Compose.
 #
-# [*base_url*]
+# @param base_url
 #   The base url for installation
 #   This allows use of a mirror that follows the same layout as the
 #   official repository
 #
-# [*raw_url*]
+# @param raw_url
 #   Override the raw URL for installation
 #   The default is to build a URL from baseurl. If rawurl is set, the caller is
 #   responsible for ensuring the URL points to the correct version and
 #   architecture.
-
-# [*curl_ensure*]
+#
+# @param curl_ensure
 #   Whether or not the curl package is ensured by this module.
-#   Defaults to true
 #
 class docker::compose(
   Optional[Enum[present,absent]] $ensure       = 'present',

Diff for: manifests/compose.pp

@@ -1,4 +1,4 @@
-# == Class: docker::config
+# @summary
 #
 class docker::config {
   if $facts['os']['family'] != 'windows' {

Diff for: manifests/config.pp

@@ -1,6 +1,16 @@
-
+# @summary
+#   A define which executes a command inside a container.
 #
-# A define which executes a command inside a container.
+# @param detach
+# @param interactive
+# @param env
+# @param tty
+# @param container
+# @param command
+# @param unless
+# @param sanitise_name
+# @param refreshonly
+# @param onlyif
 #
 define docker::exec(
   Optional[Boolean] $detach        = false,

Diff for: manifests/exec.pp

@@ -1,28 +1,30 @@
-# == Class: docker
+# @summary
+#   Module to install an up-to-date version of a Docker image
+#   from the registry
 #
-# Module to install an up-to-date version of a Docker image
-# from the registry
-#
-# === Parameters
-# [*ensure*]
+# @param ensure
 #   Whether you want the image present or absent.
 #
-# [*image*]
+# @param image
 #   If you want the name of the image to be different from the
 #   name of the puppet resource you can pass a value here.
 #
-# [*image_tag*]
+# @param image_tag
 #   If you want a specific tag of the image to be installed
 #
-# [*image_digest*]
+# @param image_digest
 #   If you want a specific content digest of the image to be installed
 #
-# [*docker_file*]
+# @param docker_file
 #   If you want to add a docker image from specific docker file
 #
-# [*docker_tar*]
+# @param docker_tar
 #   If you want to load a docker image from specific docker tar
 #
+# @param force
+#
+# @param docker_dir
+#
 define docker::image(
   Optional[Enum[present,absent,latest]] $ensure       = 'present',
   Optional[Pattern[/^[\S]*$/]]          $image        = $title,

Diff for: manifests/image.pp

@@ -1,4 +1,7 @@
-# docker::images
+# @summary
+#
+# @param images
+#
 class docker::images(
   $images
 ) {