From 42b86d1251f20a56f9540dbece06c1d1b711a802 Mon Sep 17 00:00:00 2001
From: "masaru.terada" <masaru.terada@enigmo.co.jp>
Date: Thu, 14 Nov 2024 09:14:22 +0900
Subject: [PATCH] add comment for rubygems_plugin.rb

---
 lib/rubygems_plugin.rb | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/lib/rubygems_plugin.rb b/lib/rubygems_plugin.rb
index 72805cab58..55c75da6ba 100644
--- 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.