add comment for rubygems_plugin.rb

ruby · Nov 14, 2024 · 42b86d1 · 42b86d1
1 parent 535c5e3
commit 42b86d1
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/rubygems_plugin.rb b/lib/rubygems_plugin.rb
@@ -1,5 +1,13 @@
 # frozen_string_literal: true
 
+# If this file is exist, RDoc generates and removes documents by rubygems plugins.
+#
+# In follwing cases,
+# RubyGems directly exectute RDoc::RubygemsHook.generation_hook and RDoc::RubygemsHook#remove to generate and remove documents.
+#
+# - RDoc is used as a default gem.
+# - RDoc is a old version that doesn't have rubygems_plugin.rb.
+
 require_relative 'rdoc/rubygems_hook'
 
 # To install dependency libraries of RDoc, you need to run bundle install.