fluent/fluentd

View on GitHub
templates/plugin_config_formatter/param.md.erb

Summary

Maintainability
Test Coverage
<%-
type = config[:type]
required_label = config[:required] ? "required" : "optional"
default = config[:default]
alias_name = config[:alias]
deprecated = config[:deprecated]
obsoleted = config[:obsoleted]
description = config[:desc]
param_header = "#" * (3 + level)
-%>
<%= param_header %> <%= name %> (<%= type %>) (<%= required_label %>)

<%= description %>
<%- if type == :enum -%>

Available values: <%= config[:list].join(", ") %>
<%- end -%>
<%- if default -%>

Default value: `<%= default %>`.
<%- end -%>
<%- if alias_name -%>

Alias: <%= alias_name %>
<%- end -%>
<%- if deprecated -%>

Deprecated: <%= deprecated %>
<%- end -%>
<%- if obsoleted -%>

Obsoleted: <%= :obsoleted %>
<%- end -%>