track puppet-strings integration

[bastelfreak]

puppet-strings is the new way to document Puppet code. We use this already in many modules. For example puppet-ferm: https://github.com/voxpupuli/puppet-ferm/blob/master/manifests/init.pp#L1-L48

It would be nice if we could track is. There is a rake task that generates a REFERENCE.md: bundle exec rake strings:generate:reference. If could check if this file is present in the modules root directory. If that's the case we know that the module uses puppet-strings. We could also go one step further and execute the task. That will give us information about the coverage. A module with full coverage:

$ bundle exec rake strings:generate:reference
Files:                    9
Modules:                  0 (    0 undocumented)
Classes:                  0 (    0 undocumented)
Constants:                0 (    0 undocumented)
Attributes:               0 (    0 undocumented)
Methods:                  0 (    0 undocumented)
Puppet Classes:           1 (    0 undocumented)
Puppet Data Types:        0 (    0 undocumented)
Puppet Data Type Aliases:     6 (    0 undocumented)
Puppet Defined Types:     2 (    0 undocumented)
Puppet Types:             0 (    0 undocumented)
Puppet Functions:         0 (    0 undocumented)
Puppet Providers:         0 (    0 undocumented)
Puppet Plans:             0 (    0 undocumented)
Puppet Tasks:             0 (    0 undocumented)
 100.00% documented

A module with really bad coverage would look like this:

$ bundle exec rake strings:generate:reference
[warn]: Missing @param tag for parameter 'zabbix_url' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'database_type' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'manage_repo' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'zabbix_version' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'zabbix_timezone' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'zabbix_package_state' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'zabbix_template_dir' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'web_config_owner' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'web_config_group' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'manage_vhost' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'default_vhost' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'manage_resources' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_use_ssl' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_ssl_cert' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_ssl_key' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_ssl_cipher' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_ssl_chain' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_listen_ip' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_listenport' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_listenport_ssl' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'zabbix_api_user' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'zabbix_api_pass' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'database_host' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'database_name' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'database_schema' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'database_user' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'database_password' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'database_socket' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'database_port' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'zabbix_server' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'zabbix_server_name' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'zabbix_listenport' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_php_max_execution_time' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_php_memory_limit' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_php_post_max_size' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_php_upload_max_filesize' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_php_max_input_time' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_php_always_populate_raw_post_data' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'apache_php_max_input_vars' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'ldap_cacert' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'ldap_clientcert' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'ldap_clientkey' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'ldap_reqcert' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'puppetgem' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'manage_selinux' near manifests/web.pp:188.
[warn]: Missing @param tag for parameter 'zabbix_url' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_version' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_package_state' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_timezone' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_web' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_server' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_server_ip' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_template_dir' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_web_ip' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_type' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_path' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'manage_database' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'default_vhost' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'manage_vhost' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'manage_firewall' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'manage_repo' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'manage_resources' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'manage_service' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_use_ssl' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_ssl_cert' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_ssl_key' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_ssl_cipher' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_ssl_chain' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_listen_ip' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_listenport' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_listenport_ssl' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_php_max_execution_time' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_php_memory_limit' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_php_post_max_size' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_php_upload_max_filesize' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_php_max_input_time' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'apache_php_always_populate_raw_post_data' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_api_user' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_api_pass' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'nodeid' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'listenport' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'sourceip' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'logfile' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'logfilesize' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'debuglevel' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'pidfile' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_host' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_name' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_schema' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_user' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_password' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_socket' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_port' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_charset' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'database_collate' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'startpollers' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'startipmipollers' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'startpollersunreachable' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'starttrappers' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'startpingers' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'startdiscoverers' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'starthttppollers' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'starttimers' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'javagateway' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'javagatewayport' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'startjavapollers' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'startvmwarecollectors' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'vmwarefrequency' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'vmwarecachesize' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'vmwaretimeout' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'snmptrapperfile' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'startsnmptrapper' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'listenip' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'housekeepingfrequency' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'maxhousekeeperdelete' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'senderfrequency' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'cachesize' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'cacheupdatefrequency' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'startdbsyncers' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'historycachesize' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'historyindexcachesize' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'trendcachesize' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'historytextcachesize' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'valuecachesize' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'nodenoevents' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'nodenohistory' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'timeout' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'tlscafile' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'tlscertfile' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'tlscrlfile' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'tlskeyfile' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'trappertimeout' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'unreachableperiod' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'unavailabledelay' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'unreachabledelay' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'alertscriptspath' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'externalscripts' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'fpinglocation' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'fping6location' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'sshkeylocation' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'logslowqueries' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'tmpdir' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'startproxypollers' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'proxyconfigfrequency' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'proxydatafrequency' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'allowroot' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'include_dir' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'loadmodulepath' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'loadmodule' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'manage_selinux' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'additional_service_params' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_user' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'zabbix_server_name' near manifests/init.pp:73.
[warn]: Missing @param tag for parameter 'manage_repo' near manifests/repo.pp:34.
[warn]: Missing @param tag for parameter 'manage_apt' near manifests/repo.pp:34.
[warn]: Missing @param tag for parameter 'repo_location' near manifests/repo.pp:34.
[warn]: Missing @param tag for parameter 'unsupported_repo_location' near manifests/repo.pp:34.
[warn]: Missing @param tag for parameter 'zabbix_version' near manifests/repo.pp:34.
[warn]: Missing documentation for Puppet class 'zabbix::agent' at manifests/agent.pp:219.
[warn]: Missing @param tag for parameter 'database_type' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'database_path' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'zabbix_version' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'zabbix_package_state' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'manage_database' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'manage_firewall' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'manage_repo' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'manage_resources' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'manage_service' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'zabbix_proxy' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'zabbix_proxy_ip' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'use_ip' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'zbx_templates' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'proxy_configfile_path' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'proxy_service_name' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'mode' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'zabbix_server_host' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'zabbix_server_port' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'hostname' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'listenport' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'sourceip' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'enableremotecommands' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'logremotecommands' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'logfile' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'logfilesize' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'debuglevel' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'pidfile' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'database_schema_path' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'database_host' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'database_name' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'database_schema' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'database_user' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'database_password' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'database_socket' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'database_port' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'localbuffer' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'offlinebuffer' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'heartbeatfrequency' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'configfrequency' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'datasenderfrequency' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'startpollers' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'startipmipollers' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'startpollersunreachable' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'starttrappers' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'startpingers' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'startdiscoverers' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'starthttppollers' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'javagateway' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'javagatewayport' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'startjavapollers' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'startvmwarecollectors' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'vmwarefrequency' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'vmwareperffrequency' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'vmwarecachesize' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'vmwaretimeout' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'enablesnmpbulkrequests' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'snmptrapperfile' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'snmptrapper' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'listenip' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'housekeepingfrequency' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'cachesize' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'startdbsyncers' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'historycachesize' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'historyindexcachesize' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'historytextcachesize' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'timeout' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tlsaccept' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tlscafile' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tlscertfile' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tlsconnect' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tlscrlfile' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tlskeyfile' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tlspskfile' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tlspskidentity' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tlsservercertissuer' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tlsservercertsubject' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'trappertimeout' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'unreachableperiod' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'unavaliabledelay' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'unreachabedelay' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'externalscripts' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'fpinglocation' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'fping6location' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'sshkeylocation' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'logslowqueries' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'tmpdir' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'allowroot' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'include_dir' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'loadmodulepath' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'loadmodule' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'manage_selinux' near manifests/proxy.pp:334.
[warn]: Missing @param tag for parameter 'zabbix_version' near manifests/sender.pp:21.
[warn]: Missing @param tag for parameter 'zabbix_package_state' near manifests/sender.pp:21.
[warn]: Missing @param tag for parameter 'manage_repo' near manifests/sender.pp:21.
[warn]: Missing @param tag for parameter 'database_type' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'database_path' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'zabbix_version' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'zabbix_package_state' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'manage_firewall' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'manage_repo' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'manage_database' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'manage_service' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'server_configfile_path' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'server_config_owner' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'server_config_group' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'server_service_name' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'pacemaker' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'pacemaker_resource' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'nodeid' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'listenport' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'sourceip' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'logfile' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'logfilesize' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'debuglevel' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'pidfile' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'database_schema_path' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'database_host' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'database_name' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'database_schema' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'database_user' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'database_password' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'database_socket' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'database_port' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'startpollers' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'startipmipollers' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'startpollersunreachable' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'starttrappers' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'startpingers' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'startdiscoverers' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'starthttppollers' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'starttimers' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'javagateway' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'javagatewayport' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'startjavapollers' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'startvmwarecollectors' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'vmwarefrequency' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'vmwarecachesize' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'vmwaretimeout' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'snmptrapperfile' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'startsnmptrapper' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'listenip' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'housekeepingfrequency' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'maxhousekeeperdelete' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'senderfrequency' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'cachesize' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'cacheupdatefrequency' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'startdbsyncers' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'historycachesize' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'historyindexcachesize' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'trendcachesize' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'historytextcachesize' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'valuecachesize' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'nodenoevents' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'nodenohistory' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'timeout' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'tlscafile' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'tlscertfile' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'tlscrlfile' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'tlskeyfile' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'trappertimeout' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'unreachableperiod' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'unavailabledelay' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'unreachabledelay' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'alertscriptspath' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'externalscripts' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'fpinglocation' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'fping6location' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'sshkeylocation' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'logslowqueries' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'tmpdir' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'startproxypollers' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'proxyconfigfrequency' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'proxydatafrequency' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'allowroot' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'include_dir' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'loadmodulepath' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'loadmodule' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'sslcertlocation_dir' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'sslkeylocation_dir' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'manage_selinux' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'additional_service_params' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'zabbix_user' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'manage_startup_script' near manifests/server.pp:295.
[warn]: Missing @param tag for parameter 'pidfile' near manifests/startup.pp:14.
[warn]: Missing @param tag for parameter 'agent_configfile_path' near manifests/startup.pp:14.
[warn]: Missing @param tag for parameter 'server_configfile_path' near manifests/startup.pp:14.
[warn]: Missing @param tag for parameter 'database_type' near manifests/startup.pp:14.
[warn]: Missing @param tag for parameter 'zabbix_user' near manifests/startup.pp:14.
[warn]: Missing @param tag for parameter 'additional_service_params' near manifests/startup.pp:14.
[warn]: Missing @param tag for parameter 'service_type' near manifests/startup.pp:14.
[warn]: Missing @param tag for parameter 'manage_database' near manifests/startup.pp:14.
[warn]: Missing @param tag for parameter 'service_name' near manifests/startup.pp:14.
[warn]: Missing @param tag for parameter 'apache_status' near manifests/zapache.pp:46.
[warn]: Missing @param tag for parameter 'zabbix_type' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'zabbix_web' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'zabbix_web_ip' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'zabbix_server' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'zabbix_server_ip' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'zabbix_proxy' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'zabbix_proxy_ip' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'manage_database' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'database_type' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'database_schema_path' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'database_name' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'database_user' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'database_password' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'database_host' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'database_host_ip' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'database_charset' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'database_collate' near manifests/database.pp:114.
[warn]: Missing @param tag for parameter 'templ_name' near manifests/template.pp:29.
[warn]: Missing @param tag for parameter 'templ_source' near manifests/template.pp:29.
[warn]: Missing @param tag for parameter 'zabbix_version' near manifests/javagateway.pp:53.
[warn]: Missing @param tag for parameter 'zabbix_package_state' near manifests/javagateway.pp:53.
[warn]: Missing @param tag for parameter 'manage_firewall' near manifests/javagateway.pp:53.
[warn]: Missing @param tag for parameter 'manage_repo' near manifests/javagateway.pp:53.
[warn]: Missing @param tag for parameter 'pidfile' near manifests/javagateway.pp:53.
[warn]: Missing @param tag for parameter 'listenip' near manifests/javagateway.pp:53.
[warn]: Missing @param tag for parameter 'listenport' near manifests/javagateway.pp:53.
[warn]: Missing @param tag for parameter 'startpollers' near manifests/javagateway.pp:53.
[warn]: Missing @param tag for parameter 'timeout' near manifests/javagateway.pp:53.
[warn]: Missing @param tag for parameter 'zabbix_url' near manifests/resources/web.pp:15.
[warn]: Missing @param tag for parameter 'zabbix_user' near manifests/resources/web.pp:15.
[warn]: Missing @param tag for parameter 'zabbix_pass' near manifests/resources/web.pp:15.
[warn]: Missing @param tag for parameter 'apache_use_ssl' near manifests/resources/web.pp:15.
[warn]: Missing documentation for Puppet class 'zabbix::userparameter' at manifests/userparameter.pp:31.
[warn]: Missing @param tag for parameter 'zabbix_type' near manifests/database/mysql.pp:18.
[warn]: Missing @param tag for parameter 'zabbix_version' near manifests/database/mysql.pp:18.
[warn]: Missing @param tag for parameter 'database_schema_path' near manifests/database/mysql.pp:18.
[warn]: Missing @param tag for parameter 'database_name' near manifests/database/mysql.pp:18.
[warn]: Missing @param tag for parameter 'database_user' near manifests/database/mysql.pp:18.
[warn]: Missing @param tag for parameter 'database_password' near manifests/database/mysql.pp:18.
[warn]: Missing @param tag for parameter 'database_host' near manifests/database/mysql.pp:18.
[warn]: Missing @param tag for parameter 'database_path' near manifests/database/mysql.pp:18.
[warn]: Missing @param tag for parameter 'ensure' near manifests/userparameters.pp:62.
[warn]: Missing @param tag for parameter 'source' near manifests/userparameters.pp:62.
[warn]: Missing @param tag for parameter 'content' near manifests/userparameters.pp:62.
[warn]: Missing @param tag for parameter 'script' near manifests/userparameters.pp:62.
[warn]: Missing @param tag for parameter 'script_ext' near manifests/userparameters.pp:62.
[warn]: Missing @param tag for parameter 'template' near manifests/userparameters.pp:62.
[warn]: Missing @param tag for parameter 'script_dir' near manifests/userparameters.pp:62.
[warn]: Missing @param tag for parameter 'config_mode' near manifests/userparameters.pp:62.
[warn]: Missing @param tag for parameter 'hostname' near manifests/resources/agent.pp:16.
[warn]: Missing @param tag for parameter 'ipaddress' near manifests/resources/agent.pp:16.
[warn]: Missing @param tag for parameter 'use_ip' near manifests/resources/agent.pp:16.
[warn]: Missing @param tag for parameter 'port' near manifests/resources/agent.pp:16.
[warn]: Missing @param tag for parameter 'group' near manifests/resources/agent.pp:16.
[warn]: Missing @param tag for parameter 'groups' near manifests/resources/agent.pp:16.
[warn]: Missing @param tag for parameter 'group_create' near manifests/resources/agent.pp:16.
[warn]: Missing @param tag for parameter 'templates' near manifests/resources/agent.pp:16.
[warn]: Missing @param tag for parameter 'proxy' near manifests/resources/agent.pp:16.
[warn]: Missing documentation for Puppet class 'zabbix::resources::proxy' at manifests/resources/proxy.pp:15.
[warn]: Missing @param tag for parameter 'template_dir' near manifests/resources/template.pp:16.
[warn]: Missing @param tag for parameter 'template_name' near manifests/resources/template.pp:16.
[warn]: Missing @param tag for parameter 'template_source' near manifests/resources/template.pp:16.
[warn]: Missing @param tag for parameter 'zabbix_type' near manifests/database/postgresql.pp:18.
[warn]: Missing @param tag for parameter 'zabbix_version' near manifests/database/postgresql.pp:18.
[warn]: Missing @param tag for parameter 'database_schema_path' near manifests/database/postgresql.pp:18.
[warn]: Missing @param tag for parameter 'database_name' near manifests/database/postgresql.pp:18.
[warn]: Missing @param tag for parameter 'database_user' near manifests/database/postgresql.pp:18.
[warn]: Missing @param tag for parameter 'database_password' near manifests/database/postgresql.pp:18.
[warn]: Missing @param tag for parameter 'database_host' near manifests/database/postgresql.pp:18.
[warn]: Missing @param tag for parameter 'database_path' near manifests/database/postgresql.pp:18.
[warn]: Missing @param tag for parameter 'ensure' near manifests/resources/userparameters.pp:15.
[warn]: Missing @param tag for parameter 'hostname' near manifests/resources/userparameters.pp:15.
[warn]: Missing @param tag for parameter 'template' near manifests/resources/userparameters.pp:15.
[warn]: Missing documentation for Puppet type alias 'Zabbix::Databases' at types/databases.pp:1.
[warn]: Missing documentation for Puppet type alias 'Zabbix::Historyics' at types/historyics.pp:1.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_host.rb:2.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_proxy.rb:2.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_template.rb:2.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_hostgroup.rb:4.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_application.rb:13.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_host') at lib/puppet/provider/zabbix_host/ruby.rb:2.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_template_host.rb:12.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_proxy') at lib/puppet/provider/zabbix_proxy/ruby.rb:2.
[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/zabbix_userparameters.rb:3.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_template') at lib/puppet/provider/zabbix_template/ruby.rb:2.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_hostgroup') at lib/puppet/provider/zabbix_hostgroup/ruby.rb:2.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_application') at lib/puppet/provider/zabbix_application/ruby.rb:2.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_template_host') at lib/puppet/provider/zabbix_template_host/ruby.rb:2.
[warn]: Missing a description for Puppet provider 'ruby' (resource type 'zabbix_userparameters') at lib/puppet/provider/zabbix_userparameters/ruby.rb:2.
Files:                   40
Modules:                  0 (    0 undocumented)
Classes:                  1 (    0 undocumented)
Constants:                0 (    0 undocumented)
Attributes:               0 (    0 undocumented)
Methods:                 14 (    7 undocumented)
Puppet Classes:          18 (    3 undocumented)
Puppet Data Types:        0 (    0 undocumented)
Puppet Data Type Aliases:     2 (    2 undocumented)
Puppet Defined Types:     5 (    0 undocumented)
Puppet Types:             7 (    0 undocumented)
Puppet Providers:         7 (    7 undocumented)
Puppet Functions:         0 (    0 undocumented)
Puppet Tasks:             0 (    0 undocumented)
Puppet Plans:             0 (    0 undocumented)
 64.81% documented

It might be worth to track this because this results in a todo list that's easy to work on. Those issues are low hanging fruits, good for newcommers and heavily increase the user experience for our users because they get better documentation. Our release platform, the forge, can embed the REFERENCE.md.

Instead of cloning the repository to generate statistics, we could add another task within our CI pipeline that generates it. Afterwards it could be send to our application or we pull CI data.

A start would be to check if a module contains a REFERENCE.md