Merge pull request #2651 from jhawthorn/hide_generators_in_docs

Remove generators from YARD docs
solidusio · Mar 28, 2018 · 7cb9dea · 7cb9dea
2 parents b778dec + 4e293cd
commit 7cb9dea
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/core/lib/generators/spree/custom_user/custom_user_generator.rb b/core/lib/generators/spree/custom_user/custom_user_generator.rb
@@ -3,6 +3,7 @@
 require 'rails/generators/active_record/migration'
 
 module Spree
+  # @private
   class CustomUserGenerator < Rails::Generators::NamedBase
     include ActiveRecord::Generators::Migration
 

diff --git a/core/lib/generators/spree/dummy/dummy_generator.rb b/core/lib/generators/spree/dummy/dummy_generator.rb
@@ -5,6 +5,7 @@
 require 'spree/core/version'
 
 module Spree
+  # @private
   class DummyGenerator < Rails::Generators::Base
     desc "Creates blank Rails application, installs Solidus and all sample data"
 
@@ -138,9 +139,10 @@ def gemfile_path
       end
     end
   end
-end
 
-module Spree::DummyGeneratorHelper
-  mattr_accessor :inject_extension_requirements
-  self.inject_extension_requirements = false
+  # @private
+  module DummyGeneratorHelper
+    mattr_accessor :inject_extension_requirements
+    self.inject_extension_requirements = false
+  end
 end
diff --git a/core/lib/generators/spree/install/install_generator.rb b/core/lib/generators/spree/install/install_generator.rb
@@ -5,6 +5,7 @@
 require 'bundler/cli'
 
 module Spree
+  # @private
   class InstallGenerator < Rails::Generators::Base
     CORE_MOUNT_ROUTE = "mount Spree::Core::Engine"