Merge pull request #1479 from rspec/label_Rspec_as_private

Label Rspec as @Private for docs, update other modules visibility

Author: JonRowe

lib/generators/rspec.rb

@@ -1,6 +1,7 @@
 require 'rails/generators/named_base'
 require 'rspec/rails/feature_check'
 
+# @private
 # Weirdly named generators namespace (should be `RSpec`) for compatability with
 # rails loading.
 module Rspec

lib/rspec/rails/example/controller_example_group.rb

@@ -5,6 +5,7 @@ module Rails
       ActionDispatch::Assertions::RoutingAssertions
     )
 
+    # @api public
     # Container module for controller spec functionality.
     module ControllerExampleGroup
       extend ActiveSupport::Concern

lib/rspec/rails/example/feature_example_group.rb

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # @api public
     # Container module for routing spec functionality.
     module FeatureExampleGroup
       extend ActiveSupport::Concern

lib/rspec/rails/example/helper_example_group.rb

@@ -2,6 +2,7 @@
 
 module RSpec
   module Rails
+    # @api public
     # Container module for helper specs.
     module HelperExampleGroup
       extend ActiveSupport::Concern

lib/rspec/rails/example/job_example_group.rb

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # @api public
     # Container module for job spec functionality. It is only available if
     # ActiveJob has been loaded before it.
     module JobExampleGroup

lib/rspec/rails/example/mailer_example_group.rb

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # @api public
     # Container module for mailer spec functionality. It is only available if
     # ActionMailer has been loaded before it.
     module MailerExampleGroup

lib/rspec/rails/example/model_example_group.rb

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # @api public
     # Container class for model spec functionality. Does not provide anything
     # special over the common RailsExampleGroup currently.
     module ModelExampleGroup

lib/rspec/rails/example/rails_example_group.rb

@@ -4,6 +4,7 @@
 
 module RSpec
   module Rails
+    # @api public
     # Common rails example functionality.
     module RailsExampleGroup
       extend ActiveSupport::Concern

lib/rspec/rails/example/request_example_group.rb

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # @api public
     # Container class for request spec functionality.
     module RequestExampleGroup
       extend ActiveSupport::Concern

lib/rspec/rails/example/routing_example_group.rb

@@ -7,6 +7,7 @@ module Rails
       ActionDispatch::Assertions::RoutingAssertions
     )
 
+    # @api public
     # Container module for routing spec functionality.
     module RoutingExampleGroup
       extend ActiveSupport::Concern

lib/rspec/rails/example/view_example_group.rb

@@ -2,6 +2,7 @@
 
 module RSpec
   module Rails
+    # @api public
     # Container class for view spec functionality.
     module ViewExampleGroup
       extend ActiveSupport::Concern

lib/rspec/rails/feature_check.rb

@@ -1,4 +1,3 @@
-# @api private
 module RSpec
   module Rails
     # @private

lib/rspec/rails/matchers.rb

@@ -4,6 +4,7 @@
 
 module RSpec
   module Rails
+    # @api public
     # Container module for Rails specific matchers.
     module Matchers
     end

lib/rspec/rails/matchers/be_valid.rb

@@ -33,6 +33,7 @@ def failure_message_when_negated
         end
       end
 
+      # @api public
       # Passes if the given model instance's `valid?` method is true, meaning
       # all of the `ActiveModel::Validations` passed and no errors exist. If a
       # message is not given, a default message is shown listing each error.

lib/rspec/rails/view_rendering.rb

@@ -2,6 +2,7 @@
 
 module RSpec
   module Rails
+    # @api public
     # Helpers for optionally rendering views in controller specs.
     module ViewRendering
       extend ActiveSupport::Concern