summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/rabbit_policy.erl16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/rabbit_policy.erl b/src/rabbit_policy.erl
index 6321758f58..1f7e521dfd 100644
--- a/src/rabbit_policy.erl
+++ b/src/rabbit_policy.erl
@@ -16,6 +16,22 @@
-module(rabbit_policy).
+%% Policies is a way to apply optional arguments ("x-args")
+%% to exchanges and queues in bulk, using name matching.
+%%
+%% Only one policy can apply to a given queue or exchange
+%% at a time. Priorities help determine what policy should
+%% take precedence.
+%%
+%% Policies build on runtime parameters. Policy-driven parameters
+%% are well known and therefore validated.
+%%
+%% See also:
+%%
+%% * rabbit_runtime_parameters
+%% * rabbit_policies
+%% * rabbit_registry
+
%% TODO specs
-behaviour(rabbit_runtime_parameter).