Add documentation to HookContext::Base

Author: sds

lib/overcommit/hook_context/base.rb

@@ -8,26 +8,37 @@ module Overcommit::HookContext
   # This is also important to house in a separate object so that any
   # calculations can be memoized across all hooks in a single object, which
   # helps with performance.
+  #
+  # @abstract
   class Base
+    # Creates a hook context from the given configuration and input options.
+    #
     # @param config [Overcommit::Configuration]
     # @param args [Array<String>]
+    # @param input [IO] standard input stream
     def initialize(config, args, input)
       @config = config
       @args = args
       @input = input
     end
 
     # Returns the camel-cased type of this hook (e.g. PreCommit)
+    #
+    # @return [String]
     def hook_class_name
       self.class.name.split('::').last
     end
 
     # Returns the snake-cased type of this hook (e.g. pre_commit)
+    #
+    # @return [String]
     def hook_type_name
       Overcommit::Utils.snake_case(hook_class_name)
     end
 
     # Returns the actual name of the hook script being run (e.g. pre-commit).
+    #
+    # @return [String]
     def hook_script_name
       hook_type_name.gsub('_', '-')
     end
@@ -37,7 +48,7 @@ def hook_script_name
     # This is called before the hooks are run by the [HookRunner]. Different
     # hook types can perform different setup.
     def setup_environment
-      # Implemented by subclass
+      # Implemented by subclass, if applicable
     end
 
     # Resets the environment to an appropriate state.
@@ -46,18 +57,23 @@ def setup_environment
     # Different hook types can perform different cleanup operations, which are
     # intended to "undo" the results of the call to {#setup_environment}.
     def cleanup_environment
-      # Implemented by subclass
+      # Implemented by subclass, if applicable
     end
 
     # Returns a list of files that have been modified.
     #
     # By default, this returns an empty list. Subclasses should implement if
     # there is a concept of files changing for the type of hook being run.
+    #
+    # @return [Array<String>]
     def modified_files
       []
     end
 
-    # Returns an array of lines passed to the hook via STDIN.
+    # Returns an array of lines passed to the hook via the standard input
+    # stream.
+    #
+    # @return [Array<String>]
     def input_lines
       @input_lines ||= @input.read.split("\n")
     end