Skip to content

Commit 4954e4f

Browse files
committed
add comment for rubygems_plugin.rb
1 parent 535c5e3 commit 4954e4f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

lib/rubygems_plugin.rb

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# frozen_string_literal: true
22

3+
# If this file is exist, RDoc generates and removes documents by rubygems plugins.
4+
#
5+
# In follwing cases,
6+
# RubyGems directly exectute RDoc::RubygemsHook.generation_hook and RDoc::RubygemsHook#remove to generate and remove documents.
7+
#
8+
# - RDoc is used as a default gem.
9+
# - RDoc is a old version that doesn't have rubygems_plugin.rb.
10+
311
require_relative 'rdoc/rubygems_hook'
412

513
# To install dependency libraries of RDoc, you need to run bundle install.

0 commit comments

Comments
 (0)