From 542f715d5af9878d4bfae9faf638b41111be14b8 Mon Sep 17 00:00:00 2001
From: Elliot Winkler <elliot.winkler@gmail.com>
Date: Thu, 25 Dec 2014 01:13:30 -0500
Subject: [PATCH] Documentation updates

[ci skip]
---
 lib/shoulda/matchers/action_controller/set_flash_matcher.rb     | 2 ++
 lib/shoulda/matchers/active_record/have_db_column_matcher.rb    | 1 +
 lib/shoulda/matchers/active_record/uniqueness/model.rb          | 1 +
 lib/shoulda/matchers/active_record/uniqueness/namespace.rb      | 1 +
 .../matchers/active_record/uniqueness/test_model_creator.rb     | 1 +
 lib/shoulda/matchers/active_record/uniqueness/test_models.rb    | 1 +
 lib/shoulda/matchers/matcher_context.rb                         | 1 +
 7 files changed, 8 insertions(+)

diff --git a/lib/shoulda/matchers/action_controller/set_flash_matcher.rb b/lib/shoulda/matchers/action_controller/set_flash_matcher.rb
index f9dac522..1914433d 100644
--- a/lib/shoulda/matchers/action_controller/set_flash_matcher.rb
+++ b/lib/shoulda/matchers/action_controller/set_flash_matcher.rb
@@ -149,6 +149,8 @@ module Shoulda
         SetFlashMatcher.new
       end
 
+      # @deprecated Use {#set_flash} instead.
+      # @return [SetFlashMatcher]
       def set_the_flash
         Shoulda::Matchers.warn_about_deprecated_method(
           :set_the_flash,
diff --git a/lib/shoulda/matchers/active_record/have_db_column_matcher.rb b/lib/shoulda/matchers/active_record/have_db_column_matcher.rb
index 9c7cffb1..967a1e58 100644
--- a/lib/shoulda/matchers/active_record/have_db_column_matcher.rb
+++ b/lib/shoulda/matchers/active_record/have_db_column_matcher.rb
@@ -263,6 +263,7 @@ module Shoulda
           "#{model_class.name} to #{description}"
         end
 
+        # @private
         class DecoratedColumn < SimpleDelegator
           def initialize(model, column)
             @model = model
diff --git a/lib/shoulda/matchers/active_record/uniqueness/model.rb b/lib/shoulda/matchers/active_record/uniqueness/model.rb
index 463b83b7..a5ce8487 100644
--- a/lib/shoulda/matchers/active_record/uniqueness/model.rb
+++ b/lib/shoulda/matchers/active_record/uniqueness/model.rb
@@ -1,6 +1,7 @@
 module Shoulda
   module Matchers
     module ActiveRecord
+      # @private
       module Uniqueness
         # @private
         class Model
diff --git a/lib/shoulda/matchers/active_record/uniqueness/namespace.rb b/lib/shoulda/matchers/active_record/uniqueness/namespace.rb
index 77032837..65e6d3fd 100644
--- a/lib/shoulda/matchers/active_record/uniqueness/namespace.rb
+++ b/lib/shoulda/matchers/active_record/uniqueness/namespace.rb
@@ -1,6 +1,7 @@
 module Shoulda
   module Matchers
     module ActiveRecord
+      # @private
       module Uniqueness
         # @private
         class Namespace
diff --git a/lib/shoulda/matchers/active_record/uniqueness/test_model_creator.rb b/lib/shoulda/matchers/active_record/uniqueness/test_model_creator.rb
index 5b3a430e..78f86e34 100644
--- a/lib/shoulda/matchers/active_record/uniqueness/test_model_creator.rb
+++ b/lib/shoulda/matchers/active_record/uniqueness/test_model_creator.rb
@@ -3,6 +3,7 @@ require 'thread'
 module Shoulda
   module Matchers
     module ActiveRecord
+      # @private
       module Uniqueness
         # @private
         class TestModelCreator
diff --git a/lib/shoulda/matchers/active_record/uniqueness/test_models.rb b/lib/shoulda/matchers/active_record/uniqueness/test_models.rb
index f6689ee4..2283af96 100644
--- a/lib/shoulda/matchers/active_record/uniqueness/test_models.rb
+++ b/lib/shoulda/matchers/active_record/uniqueness/test_models.rb
@@ -3,6 +3,7 @@ require 'thread'
 module Shoulda
   module Matchers
     module ActiveRecord
+      # @private
       module Uniqueness
         # @private
         module TestModels
diff --git a/lib/shoulda/matchers/matcher_context.rb b/lib/shoulda/matchers/matcher_context.rb
index 830d1026..16ef8bd1 100644
--- a/lib/shoulda/matchers/matcher_context.rb
+++ b/lib/shoulda/matchers/matcher_context.rb
@@ -1,5 +1,6 @@
 module Shoulda
   module Matchers
+    # @private
     class MatcherContext
       def initialize(context)
         @context = context