Update documentation for CLI Option and Plugin and setup .yardocopts

Author: codenamev

.yardopts

@@ -0,0 +1 @@
+--no-private --protected exe/* lib/**/*.rb - CODE_OF_CONDUCT.md README.md LICENSE.txt

lib/git_commander/cli.rb

@@ -41,7 +41,7 @@ def say(message)
     #
     # @param command [Command] the git-cmd command to parse the arguments for
     # @param arguments [Array] the command line arguments
-    # @return options [Array] the GitCommander::Command options with values
+    # @return [Array<GitCommander::Command::Option>] the available options with values
     def parse_command_options!(command, arguments)
       parser = configure_option_parser_for_command(command)
       parser.parse!(arguments)

lib/git_commander/command/option.rb

@@ -2,11 +2,20 @@
 
 module GitCommander
   class Command
-    # @nodoc
+    # @abstract Wraps [Command] arguments, flags, and switches in a generic
+    #           object to normalize their representation in the context of a
+    #           [Command].
     class Option
       attr_reader :default, :description, :name
       attr_writer :value
 
+      # Creates a [Option] object.
+      #
+      # @param name [String, Symbol] the name of the option, these are unique per [Command]
+      # @param default [anything] the default value the option should have
+      # @param description [String] a description of the option for display in
+      #        the [Command]'s help text
+      # @param value [anything] a value for the option
       def initialize(name:, default: nil, description: nil, value: nil)
         @name = name.to_sym
         @default = default

lib/git_commander/plugin.rb

@@ -11,14 +11,10 @@ module GitCommander
   # context.  Plugins can define their own inline gems, and can define
   # additional Commands.
   #
-  # @example Loadable Command file with native `git` plugin
-  #   # This is a unique example of using `plugin` without any options.  It
-  #   # uses the `git` plugin provided natively with this gem. Most times you will
-  #   # use a path: "path/to/my/plugin", or url: "https://example.com/myplugin"
-  #   plugin :git
-  #   command :local_branches do |cmd|
-  #     git.branches.local.map(&:name)
-  #   end
+  # @example A simple `git` plugin
+  #   require "git"
+  #   git_instance = Git.open(Dir.pwd, log: GitCommander.logger)
+  #   GitCommander::Plugin.new(:git, source_instance: git_instance)
   #
   class Plugin
     attr_accessor :executor, :name, :registry