rbeapi 0.5.0 → 0.5.1

data/lib/rbeapi/api/routemaps.rb

@@ -32,10 +32,10 @@
 require 'rbeapi/api'
 
 ##
-# Rbeapi toplevel namespace
+# Rbeapi toplevel namespace.
 module Rbeapi
   ##
-  # Api is module namespace for working with the EOS command API
+  # Api is module namespace for working with the EOS command API.
   module Api
     ##
     # The Routemaps class manages routemaps. A route map is a list of rules
@@ -47,7 +47,7 @@ module Rbeapi
     #
     class Routemaps < Entity
       ##
-      # get returns a hash of routemap configurations for the given name
+      # get returns a hash of routemap configurations for the given name.
       #
       # @example
       #   {
@@ -81,12 +81,12 @@ module Rbeapi
       #     }
       #   }
       #
-      # @param [String] :name The routemap name to return a resource for from
-      #   the nodes configuration
+      # @param name [String] The routemap name to return a resource for from
+      #   the nodes configuration.
       #
       # @return [nil, Hash<Symbol, Object>] Returns the routemap resource as a
       #   Hash. If the specified name is not found in the nodes current
-      #   configuration a nil object is returned
+      #   configuration a nil object is returned.
       def get(name)
         parse_entries(name)
       end
@@ -160,8 +160,8 @@ module Rbeapi
       #     }
       #   }
       #
-      # @return [nil, Hash<Symbol, Object>] returns a hash that represents the
-      #   entire routemap collection from the nodes running configuration.  If
+      # @return [nil, Hash<Symbol, Object>] Returns a hash that represents the
+      #   entire routemap collection from the nodes running configuration. If
       #   there are no routemap names configured, this method will return nil.
       def getall
         routemaps = config.scan(/(?<=^route-map\s)[^\s]+/)
@@ -176,8 +176,10 @@ module Rbeapi
       #
       # @api private
       #
-      # @return [nil, Hash<Symbol, Object>] returns a hash that represents the
-      #   rules for routemaps from the nodes running configuration.  If
+      # @param name [String] The routemap name.
+      #
+      # @return [nil, Hash<Symbol, Object>] Returns a hash that represents the
+      #   rules for routemaps from the nodes running configuration. If
       #   there are no routemaps configured, this method will return nil.
       def parse_entries(name)
         entries = config.scan(/^route-map\s#{name}\s.+$/)
@@ -199,10 +201,20 @@ module Rbeapi
       #
       # @api private
       #
-      # @return [Hash<Symbol, Object>] returns a hash that represents the
-      #   rules for routemaps from the nodes running configuration.  If
+      # @param rules [Hash] Rules configuration options.
+      #
+      # @option rules match [Array] The match options.
+      #
+      # @option rules set [Array] The set options.
+      #
+      # @option rules continue [String] The continue value.
+      #
+      # @option rules description [String] The description value.
+      #
+      # @return [Hash<Symbol, Object>] Returns a hash that represents the
+      #   rules for routemaps from the nodes running configuration. If
       #   there are no routemaps configured, this method will return an empty
-      #    hash.
+      #   hash.
       def parse_rules(rules)
         rules.split("\n").each_with_object({}) do |rule, rule_hsh|
           mdata = /\s{3}(\w+)\s/.match(rule)
@@ -225,7 +237,21 @@ module Rbeapi
       private :parse_rules
 
       ##
-      # name_commands is utilized to initially prepare the routemap
+      # name_commands is utilized to initially prepare the routemap.
+      #
+      # @param name [String] The routemap name.
+      #
+      # @param action [String] The action value.
+      #
+      # @param seqno [String] The seqno value.
+      #
+      # @param opts [Hash] The configuration options.
+      #
+      # @option opts default [Boolean] The default value.
+      #
+      # @option opts enable [Boolean] The enable value.
+      #
+      # @return [Array] Returns the prepared eos command.
       def name_commands(name, action, seqno, opts = {})
         if opts[:default] == true
           cmd = "default route-map #{name}"
@@ -245,35 +271,35 @@ module Rbeapi
       #
       # rubocop:disable Metrics/MethodLength
       #
-      # @commands
+      # ===Commands
       #   route-map <name> action <value> seqno <value> description <value>
       #   match <value> set <value> continue <value>
       #
-      # @param [String] :name The name of the routemap to create
+      # @param name [String] The name of the routemap to create.
       #
-      # @param [String] :action Either permit or deny
+      # @param action [String] Either permit or deny.
       #
-      # @param [Integer] :seqno The sequence number
+      # @param seqno [Integer] The sequence number value.
       #
-      # @param [hash] :opts Optional keyword arguments
+      # @param opts [hash] Optional keyword arguments.
       #
-      # @option :opts [Boolean] :default Set routemap to default
+      # @option opts default [Boolean] Set routemap to default.
       #
-      # @option :opts [String] :description A description for the routemap
+      # @option opts description [String] A description for the routemap.
       #
-      # @option :opts [Array] :match routemap match rule
+      # @option opts match [Array] routemap match rule.
       #
-      # @option :opts [String] :set Sets route attribute
+      # @option opts set [String] Sets route attribute.
       #
-      # @option :opts [String] :continue The routemap sequence number to
+      # @option opts continue [String] The routemap sequence number to
       #   continue on.
       #
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option :opts [Boolean] :default Configure the routemap to default.
+      # @option opts default [Boolean] Configure the routemap to default.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def create(name, action, seqno, opts = {})
         if opts.empty?
           cmds = name_commands(name, action, seqno)
@@ -306,6 +332,16 @@ module Rbeapi
       ##
       # remove_match_statemements removes all match rules for the
       # specified routemap
+      #
+      # @param name [String] The routemap name.
+      #
+      # @param action [String] The action value.
+      #
+      # @param seqno [String] The seqno value.
+      #
+      # @param cmds [Array] Array of eos commands.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
       def remove_match_statements(name, action, seqno, cmds)
         entries = parse_entries(name)
         return nil unless entries
@@ -322,6 +358,16 @@ module Rbeapi
       ##
       # remove_set_statemements removes all set rules for the
       # specified routemap
+      #
+      # @param name [String] The routemap name.
+      #
+      # @param action [String] The action value.
+      #
+      # @param seqno [String] The seqno value.
+      #
+      # @param cmds [Array] Array of eos commands.
+      #
+      # @return [Boolean] Returns true if the command completed successfully.
       def remove_set_statements(name, action, seqno, cmds)
         entries = parse_entries(name)
         return nil unless entries
@@ -340,16 +386,16 @@ module Rbeapi
       # running configuration. If the delete method is called and the
       # routemap name does not exist, this method will succeed.
       #
-      # @commands
+      # ===Commands
       #   no route-map <name> <action> <seqno>
       #
-      # @param [String] :name The routemap name to delete from the node.
+      # @param name [String] The routemap name to delete from the node.
       #
-      # @param [String] :action Either permit or deny
+      # @param action [String] Either permit or deny.
       #
-      # @param [Integer] :seqno The sequence number
+      # @param seqno [Integer] The sequence number.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def delete(name, action, seqno)
         configure(["no route-map #{name} #{action} #{seqno}"])
       end
@@ -358,20 +404,20 @@ module Rbeapi
       # This method will attempt to default the routemap from the nodes
       # operational config. Since routemaps do not exist by default,
       # the default action is essentially a negation and the result will
-      # be the removal of the routemap clause.
-      # If the routemap does not exist then this
-      # method will not perform any changes but still return True
+      # be the removal of the routemap clause. If the routemap does not
+      # exist then this method will not perform any changes but still
+      # return True.
       #
-      # @commands
+      # ===Commands
       #   no route-map <name>
       #
-      # @param [String] :name The routemap name to set to default.
+      # @param name [String] The routemap name to set to default.
       #
-      # @param [String] :action Either permit or deny
+      # @param action [String] Either permit or deny.
       #
-      # @param [Integer] :seqno The sequence number
+      # @param seqno [Integer] The sequence number.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def default(name, action, seqno)
         configure(["default route-map #{name} #{action} #{seqno}"])
       end
@@ -380,18 +426,18 @@ module Rbeapi
       # set_match_statements will set the match values for a specified routemap.
       # If the specified routemap does not exist, it will be created.
       #
-      # @commands
+      # ===Commands
       #   route-map <name> action <value> seqno <value> match <value>
       #
-      # @param [String] :name The name of the routemap to create
+      # @param name [String] The name of the routemap to create.
       #
-      # @param [String] :action Either permit or deny
+      # @param action [String] Either permit or deny.
       #
-      # @param [Integer] :seqno The sequence number
+      # @param seqno [Integer] The sequence number.
       #
-      # @param [Array] :value The routemap match rules
+      # @param value [Array] The routemap match rules.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_match_statements(name, action, seqno, value)
         cmds = ["route-map #{name} #{action} #{seqno}"]
         remove_match_statements(name, action, seqno, cmds)
@@ -405,18 +451,18 @@ module Rbeapi
       # set_set_statements will set the set values for a specified routemap.
       # If the specified routemap does not exist, it will be created.
       #
-      # @commands
+      # ===Commands
       #   route-map <name> action <value> seqno <value> set <value>
       #
-      # @param [String] :name The name of the routemap to create
+      # @param name [String] The name of the routemap to create.
       #
-      # @param [String] :action Either permit or deny
+      # @param action [String] Either permit or deny.
       #
-      # @param [Integer] :seqno The sequence number
+      # @param seqno [Integer] The sequence number.
       #
-      # @param [Array] :value The routemap set rules
+      # @param value [Array] The routemap set rules.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_set_statements(name, action, seqno, value)
         cmds = ["route-map #{name} #{action} #{seqno}"]
         remove_set_statements(name, action, seqno, cmds)
@@ -430,18 +476,18 @@ module Rbeapi
       # set_continue will set the continue value for a specified routemap.
       # If the specified routemap does not exist, it will be created.
       #
-      # @commands
+      # ===Commands
       #   route-map <name> action <value> seqno <value> continue <value>
       #
-      # @param [String] :name The name of the routemap to create
+      # @param name [String] The name of the routemap to create.
       #
-      # @param [String] :action Either permit or deny
+      # @param action [String] Either permit or deny.
       #
-      # @param [Integer] :seqno The sequence number
+      # @param seqno [Integer] The sequence number.
       #
-      # @param [Integer] :value The continue value
+      # @param value [Integer] The continue value.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_continue(name, action, seqno, value)
         cmds = ["route-map #{name} #{action} #{seqno}"]
         cmds << 'no continue'
@@ -453,18 +499,18 @@ module Rbeapi
       # set_description will set the description for a specified routemap.
       # If the specified routemap does not exist, it will be created.
       #
-      # @commands
+      # ===Commands
       #   route-map <name> action <value> seqno <value> description <value>
       #
-      # @param [String] :name The name of the routemap to create
+      # @param name [String] The name of the routemap to create.
       #
-      # @param [String] :action Either permit or deny
+      # @param action [String] Either permit or deny.
       #
-      # @param [Integer] :seqno The sequence number
+      # @param seqno [Integer] The sequence number.
       #
-      # @param [String] :value The description value
+      # @param value [String] The description value.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_description(name, action, seqno, value)
         cmds = ["route-map #{name} #{action} #{seqno}"]
         cmds << 'no description'

data/lib/rbeapi/api/snmp.rb

@@ -32,17 +32,17 @@
 require 'rbeapi/api'
 
 ##
-# Rbeapi toplevel namespace
+# Rbeapi toplevel namespace.
 module Rbeapi
   ##
-  # Api is module namespace for working with the EOS command API
+  # Api is module namespace for working with the EOS command API.
   module Api
     ##
     # The Snmp class provides a class implementation for working with the
-    # nodes SNMP configuration entity.  This class presents an abstraction
+    # nodes SNMP configuration entity. This class presents an abstraction
     # of the node's snmp configuration from the running config.
     #
-    # @eos_version 4.13.7M
+    # @since eos_version 4.13.7M
     class Snmp < Entity
       DEFAULT_SNMP_LOCATION = ''
       DEFAULT_SNMP_CONTACT = ''
@@ -63,7 +63,7 @@ module Rbeapi
       #     source_interface: <string>
       #   }
       #
-      # @return[Hash<Symbol, Object>] Returns the snmp resource as a Hash
+      # @return[Hash<Symbol, Object>] Returns the snmp resource as a Hash.
       def get
         response = {}
         response.merge!(parse_location)
@@ -77,14 +77,14 @@ module Rbeapi
 
       ##
       # parse_location scans the running config from the node and parses
-      # the snmp location value if it exists in the configuration.  If the
+      # the snmp location value if it exists in the configuration. If the
       # snmp location is not configure, then the DEFAULT_SNMP_LOCATION string
-      # is returned.  The Hash returned by this method is merged into the
+      # is returned. The Hash returned by this method is merged into the
       # snmp resource Hash returned by the get method.
       #
       # @api private
       #
-      # @return [Hash<Symbol,Object>] resource Hash attribute
+      # @return [Hash<Symbol,Object>] Returns the resource Hash attribute.
       def parse_location
         mdata = /snmp-server location (.+)$/.match(config)
         { location: mdata.nil? ? DEFAULT_SNMP_LOCATION : mdata[1] }
@@ -93,14 +93,14 @@ module Rbeapi
 
       ##
       # parse_contact scans the running config form the node and parses
-      # the snmp contact value if it exists in the configuration.  If the
+      # the snmp contact value if it exists in the configuration. If the
       # snmp contact is not configured, then the DEFAULT_SNMP_CONTACT value
-      # is returned.  The Hash returned by this method is merged into the
+      # is returned. The Hash returned by this method is merged into the
       # snmp resource Hash returned by the get method.
       #
       # @api private
       #
-      # @return [Hash<Symbol,Object] resource Hash attribute
+      # @return [Hash<Symbol,Object] Returns the resource Hash attribute.
       def parse_contact
         mdata = /snmp-server contact (.+)$/.match(config)
         { contact: mdata.nil? ? DEFAULT_SNMP_CONTACT : mdata[1] }
@@ -109,14 +109,14 @@ module Rbeapi
 
       ##
       # parse_chassis_id scans the running config from the node and parses
-      # the snmp chassis id value if it exists in the configuration.  If the
+      # the snmp chassis id value if it exists in the configuration. If the
       # snmp chassis id is not configured, then the DEFAULT_SNMP_CHASSIS_ID
-      # value is returned.  The Hash returned by this method is intended to
-      # be merged into the snmp resource Hash
+      # value is returned. The Hash returned by this method is intended to
+      # be merged into the snmp resource Hash.
       #
       # @api private
       #
-      # @return [Hash<Symbol,Object>] resource Hash attribute
+      # @return [Hash<Symbol,Object>] Returns the resource Hash attribute.
       def parse_chassis_id
         mdata = /snmp-server chassis-id (.+)$/.match(config)
         { chassis_id: mdata.nil? ? DEFAULT_SNMP_CHASSIS_ID : mdata[1] }
@@ -126,14 +126,14 @@ module Rbeapi
       ##
       # parse_source_interface scans the running config from the node and
       # parses the snmp source interface value if it exists in the
-      # configuration.  If the snmp source interface is not configured, then
-      # the DEFAULT_SNMP_SOURCE_INTERFACE value is returned.  The Hash
+      # configuration. If the snmp source interface is not configured, then
+      # the DEFAULT_SNMP_SOURCE_INTERFACE value is returned. The Hash
       # returned by this method is intended to be merged into the snmmp
-      # resource Hash
+      # resource Hash.
       #
       # @api private
       #
-      # @return [Hash<Symbol, Object>] resource Hash attribute
+      # @return [Hash<Symbol, Object>] Returns the resource Hash attribute.
       def parse_source_interface
         mdata = /snmp-server source-interface (.+)$/.match(config)
         { source_interface: mdata.nil? ? '' : mdata[1] }
@@ -142,14 +142,14 @@ module Rbeapi
 
       ##
       # parse_communities scans the running config from the node and parses all
-      # of the configure snmp community strings.  If there are no configured
+      # of the configure snmp community strings. If there are no configured
       # snmp community strings, the community value is set to an empty array.
       # The returned hash is intended to be merged into the global snmp
-      # resource hash
+      # resource hash.
       #
       # @api private
       #
-      # @return [Hash<Hash>] resource hash attribute
+      # @return [Hash<Hash>] Returns the resource hash attribute.
       def parse_communities
         values = config.scan(/snmp-server community (\w+) (ro|rw)[ ]?(.+)?$/)
         communities = values.each_with_object({}) do |value, hsh|
@@ -162,9 +162,9 @@ module Rbeapi
 
       ##
       # parse_notifications scans the running configuration and parses all of
-      # the snmp trap notifications configuration.  It is expected the trap
-      # configuration is in the running config.  The returned hash is intended
-      # to be merged into the resource hash
+      # the snmp trap notifications configuration. It is expected the trap
+      # configuration is in the running config. The returned hash is intended
+      # to be merged into the resource hash.
       def parse_notifications
         traps = config.scan(/(default|no)?[ ]?snmp-server enable traps (.+)$/)
         all = config.scan(/(default|no)?[ ]?snmp-server enable traps$/).first
@@ -180,24 +180,26 @@ module Rbeapi
 
       ##
       # set_notification configures the snmp trap notification for the
-      # specified trap.  The name option accepts the snmp trap name to
+      # specified trap. The name option accepts the snmp trap name to
       # configure or the keyword all to globally enable or disable
-      # notifications.  If the optional state argument is not provided then the
+      # notifications. If the optional state argument is not provided then the
       # default state is default.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   snmp-server enable traps <name>
       #   no snmp-server enable traps <name>
       #   default snmp-server enable traps <name>
       #
-      # @param [String] :name The name of the trap to configure or the keyword
-      #   all.  If this option is not specified, then the value of 'all' is
-      #   used as the default.
+      # @param opts [Hash] The configuration parameters.
       #
-      # @param [String] :state The state to configure the trap notification.
-      #   Valid values include 'on', 'off' or 'default'
+      # @option opts name [String] The name of the trap to configure or the
+      #   keyword all. If this option is not specified, then the value of
+      #   'all' is used as the default.
+      #
+      # @option opts state [String] The state to configure the trap
+      #   notification. Valid values include 'on', 'off' or 'default'.
       def set_notification(opts = {})
         name = opts[:name]
         name = nil if name == 'all'
@@ -208,29 +210,29 @@ module Rbeapi
 
       ##
       # set_location updates the snmp location value in the nodes running
-      # configuration.  If enable is false, then the snmp location value is
-      # negated using the no keyword.  If the default keyword is set to true,
+      # configuration. If enable is false, then the snmp location value is
+      # negated using the no keyword. If the default keyword is set to true,
       # then the snmp location value is defaulted using the default keyword.
       # The default parameter takes precedence over the enable keyword.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   snmp-server location <value>
       #   no snmp-server location
       #   default snmp-server location
       #
-      # @param [Hash] opts The configuration parameters
+      # @param opts [Hash] The configuration parameters.
       #
-      # @option opts [string] :value The snmp location value to configure
+      # @option opts value [string] The snmp location value to configure.
       #
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option opts [Boolean] :default Configure the snmp location value
-      #   using the default keyword
+      # @option opts default [Boolean] Configure the snmp location value
+      #   using the default keyword.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_location(opts = {})
         cmd = command_builder('snmp-server location', opts)
         configure(cmd)
@@ -238,30 +240,30 @@ module Rbeapi
 
       ##
       # set_contact updates the snmp contact value in the nodes running
-      # configuration.  If enable is false in the opts Hash then
-      # the snmp contact value is negated using the no keyword.  If the
+      # configuration. If enable is false in the opts Hash then
+      # the snmp contact value is negated using the no keyword. If the
       # default keyword is set to true, then the snmp contact value is
-      # defaulted using the default keyword.  The default parameter takes
+      # defaulted using the default keyword. The default parameter takes
       # precedence over the enable keyword.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   snmp-server contact <value>
       #   no snmp-server contact
       #   default snmp-server contact
       #
-      # @param [Hash] opts The configuration parameters
+      # @param opts [Hash] The configuration parameters.
       #
-      # @option opts [string] :value The snmp contact value to configure
+      # @option opts value [string] The snmp contact value to configure.
       #
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option opts [Boolean] :default Configures the snmp contact value
-      #   using the default keyword
+      # @option opts default [Boolean] Configures the snmp contact value
+      #   using the default keyword.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_contact(opts = {})
         cmd = command_builder('snmp-server contact', opts)
         configure(cmd)
@@ -269,30 +271,30 @@ module Rbeapi
 
       ##
       # set_chassis_id updates the snmp chassis id value in the nodes
-      # running configuration.  If enable is false in the opts
+      # running configuration. If enable is false in the opts
       # Hash then the snmp chassis id value is negated using the no
-      # keyword.  If the default keyword is set to true, then the snmp
-      # chassis id value is defaulted using the default keyword.  The default
+      # keyword. If the default keyword is set to true, then the snmp
+      # chassis id value is defaulted using the default keyword. The default
       # keyword takes precedence over the enable keyword.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   snmp-server chassis-id <value>
       #   no snmp-server chassis-id
       #   default snmp-server chassis-id
       #
-      # @param [Hash] opts The configuration parameters
+      # @param opts [Hash] The configuration parameters
       #
-      # @option opts [string] :value The snmp chassis id value to configure
+      # @option opts value [string] The snmp chassis id value to configure
       #
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
       #
-      # @option opts [Boolean] :default Configures the snmp chassis id value
-      #   using the default keyword
+      # @option opts default [Boolean] Configures the snmp chassis id value
+      #   using the default keyword.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_chassis_id(opts = {})
         cmd = command_builder('snmp-server chassis-id', opts)
         configure(cmd)
@@ -300,30 +302,30 @@ module Rbeapi
 
       ##
       # set_source_interface updates the snmp source interface value in the
-      # nodes running configuration.  If enable is false in the opts
+      # nodes running configuration. If enable is false in the opts
       # Hash then the snmp source interface is negated using the no keyword.
       # If the default keyword is set to true, then the snmp source interface
-      # value is defaulted using the default keyword.  The default keyword
+      # value is defaulted using the default keyword. The default keyword
       # takes precedence over the enable keyword.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   snmp-server source-interface <value>
       #   no snmp-server source-interface
       #   default snmp-server source-interface
       #
-      # @param [Hash] opts The configuration parameters
+      # @param opts [Hash] The configuration parameters.
       #
-      # @option opts [string] :value The snmp source interface value to
-      #   configure.  This method will not ensure the interface is present
-      #   in the configuration
-      # @option :opts [Boolean] :enable If false then the command is
+      # @option opts value [string] The snmp source interface value to
+      #   configure. This method will not ensure the interface is present
+      #   in the configuration.
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
-      # @option opts [Boolean] :default Configures the snmp source interface
-      #   value using the default keyword
+      # @option opts default [Boolean] Configures the snmp source interface
+      #   value using the default keyword.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_source_interface(opts = {})
         cmd = command_builder('snmp-server source-interface', opts)
         configure(cmd)
@@ -331,65 +333,67 @@ module Rbeapi
 
       ##
       # add_community adds a new snmp community to the nodes running
-      # configuration.  This function is a convenience function that passes the
+      # configuration. This function is a convenience function that passes the
       # message to set_community_access.
       #
       # @see set_community_access
       #
-      # @param [String] :name The name of the snmp community to add to the
+      # @param name [String] The name of the snmp community to add to the
       #   nodes running configuration.
       #
-      # @param [String] :access Specifies the access level to assign to the
-      #   new snmp community.  Valid values are 'rw' or 'ro'
+      # @param access [String] Specifies the access level to assign to the
+      #   new snmp community. Valid values are 'rw' or 'ro'.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def add_community(name, access = 'ro')
         set_community_access(name, access)
       end
 
       ##
       # remove_community removes the specified community from the nodes running
-      # configuration.  If the specified name is not configured, this method
+      # configuration. If the specified name is not configured, this method
       # will still return successfully.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   no snmp-server community <name>
       #
-      # @param [String] :name The name of the snmp community to add to the
+      # @param name [String] The name of the snmp community to add to the
       #   nodes running configuration.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def remove_community(name)
         configure "no snmp-server community #{name}"
       end
 
       ##
       # set_community_acl configures the acl to apply to the specified
-      # community name.  When enable is true, it will remove the
+      # community name. When enable is true, it will remove the
       # the named community and then add the new acl entry.
       #
-      # @eos_version 4.13.7M
+      # @since eos_version 4.13.7M
       #
-      # @commands
+      # ===Commands
       #   no snmp-server <name> [ro|rw] <value>
       #   snmp-server <name> [ro|rw] <value>
       #
-      # @param [String] :name The name of the snmp community to add to the
+      # @param name [String] The name of the snmp community to add to the
       #   nodes running configuration.
       #
-      # @param [Hash] opts The configuration parameters
+      # @param opts [Hash] The configuration parameters.
       #
-      # @option opts [String] :value The name of the acl to apply to the snmp
+      # @option opts value [String] The name of the acl to apply to the snmp
       #   community in the nodes config. If nil, then the community name
       #   allows access to all objects.
-      # @option opts [Boolean] :enable If false then the command is
+      #
+      # @option opts enable [Boolean] If false then the command is
       #   negated. Default is true.
-      # @option opts [Boolean] :default Configure the snmp community name
+      #
+      # @option opts default [Boolean] Configure the snmp community name
       #   using the default keyword. Default takes precedence over enable.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_community_acl(name, opts = {})
         value = opts[:value]
         enable = opts.fetch(:enable, true)
@@ -407,11 +411,11 @@ module Rbeapi
       # set_community_access configures snmp-server community with designated
       #   name and access values.
       #
-      # @param [String] :name The snmp-server community name value
+      # @param name [String] The snmp-server community name value.
       #
-      # @param [String] :access The snmp-server community access value
+      # @param access [String] The snmp-server community access value.
       #
-      # @return [Boolean] returns true if the command completed successfully
+      # @return [Boolean] Returns true if the command completed successfully.
       def set_community_access(name, access)
         configure "snmp-server community #{name} #{access}"
       end