Add comments to module AnnotateRoutes and nested classes

Author: nard-tech

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]

lib/annotate/annotate_routes/annotation_processor.rb

@@ -2,7 +2,9 @@
 require_relative './helpers'
 require_relative './header_generator'
 
+# This module provides methods for annotating config/routes.rb.
 module AnnotateRoutes
+  # This class provides methods for adding annotation to config/routes.rb.
   class AnnotationProcessor < BaseProcessor
     include Helpers
 

lib/annotate/annotate_routes/base_processor.rb

@@ -1,4 +1,6 @@
+# This module provides methods for annotating config/routes.rb.
 module AnnotateRoutes
+  # This class is abstract class of classes adding and removing annotation to config/routes.rb.
   class BaseProcessor
     class << self
       # @param options [Hash]

lib/annotate/annotate_routes/header_generator.rb

@@ -1,6 +1,8 @@
 require_relative './helpers'
 
+# 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

lib/annotate/annotate_routes/helpers.rb

@@ -1,4 +1,7 @@
+# This module provides methods for annotating config/routes.rb.
 module AnnotateRoutes
+  # This module contains methods used in multiple classes.
+  # This module is included in AnnotationProcessor and HeaderGenerator.
   module Helpers
     MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/).freeze
 

lib/annotate/annotate_routes/removal_processor.rb

@@ -1,6 +1,8 @@
 require_relative './base_processor'
 
+# This module provides methods for annotating config/routes.rb.
 module AnnotateRoutes
+  # This class provides methods for removing annotation from config/routes.rb.
   class RemovalProcessor < BaseProcessor
     # @return [String]
     def execute