Add comments to module AnnotateRoutes and nested classes

ctran · Feb 9, 2024 · 50b50bb · 50b50bb
1 parent 31b705d
commit 50b50bb
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/lib/annotate/annotate_routes.rb b/lib/annotate/annotate_routes.rb
@@ -21,6 +21,7 @@
 require_relative './annotate_routes/annotation_processor'
 require_relative './annotate_routes/removal_processor'
 
+# This module provides methods for annotating config/routes.rb.
 module AnnotateRoutes
   class << self
     # @param options [Hash]

diff --git a/lib/annotate/annotate_routes/header_generator.rb b/lib/annotate/annotate_routes/header_generator.rb
@@ -1,6 +1,8 @@
 require_relative './magic_comments_extractor'
 
+# This module provides methods for annotating config/routes.rb.
 module AnnotateRoutes
+  # This class processes result of `rake routes` and generate content enbeded in config/routes.rb.
   class HeaderGenerator
     PREFIX = '== Route Map'.freeze
     PREFIX_MD = '## Route Map'.freeze