README.md in puppet-lint-param-docs-1.3.1 vs README.md in puppet-lint-param-docs-1.4.0

@@ -29,21 +29,60 @@
 ```
 WARNING: missing documentation for class parameter foo::bar
 WARNING: missing documentation for defined type parameter foo::baz
 ```
 
+### Documentation styles
+
+The check will accept any of the following styles:
+
+#### Puppet Strings
+
+Used by [Puppet Strings](https://github.com/puppetlabs/puppetlabs-strings).
+
+    # Example class
+    #
+    # @param foo example
+    define example($foo) { }
+
+#### Puppet Doc style
+
+Used by the [puppet-doc](https://docs.puppetlabs.com/puppet/latest/reference/man/doc.html)
+command, generally deprecated in favour of Puppet Strings.
+
+    # Example class
+    #
+    # === Parameters:
+    #
+    # [*foo*] example
+    #
+    class example($foo) { }
+
+#### Kafo rdoc style
+
+Used in [kafo](https://github.com/theforeman/kafo#documentation) following an
+rdoc style.
+
+    # Example class
+    #
+    # === Parameters:
+    #
+    # $foo:: example
+    #
+    class example($foo) { }
+
 ### Selective rake task
 
 The usual puppet-lint rake task checks all manifests, which isn't always
 desirable with this particular check.  If your module contains many classes,
 some of which you don't wish to document, then you can exclude them using
 [control comments](http://puppet-lint.com/controlcomments/) or by using this
 helper to customise the lint rake task:
 
-  require 'puppet-lint-param-docs/tasks'
-  PuppetLintParamDocs.define_selective do |config|
-    config.pattern = ['manifests/init.pp', 'manifests/other/**/*.pp']
-  end
+    require 'puppet-lint-param-docs/tasks'
+    PuppetLintParamDocs.define_selective do |config|
+      config.pattern = ['manifests/init.pp', 'manifests/other/**/*.pp']
+    end
 
 This would disable the parameter_documentation check by default, but then
 defines a new rake task (which runs after `lint`) specifically for the files
 given in `config.pattern`.