lib/ddplugin/plugin.rb in ddplugin-1.0.1 vs lib/ddplugin/plugin.rb in ddplugin-1.0.2
- old
+ new
@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
module DDPlugin
# A module that contains class methods for plugins. It provides functions
# for setting identifiers and finding plugins. Plugin classes should extend
# this module.
module Plugin
# @overload identifiers(*identifiers)
#
# Sets the identifiers for this class.
#
- # @param [Array<Symbol>] identifiers A list of identifiers to assign to
- # this class.
+ # @param [Array<Symbol, String>] identifiers A list of identifiers to
+ # assign to this class.
#
# @return [void]
#
# @overload identifiers
#
@@ -32,11 +34,12 @@
# @overload identifier(identifier)
#
# Sets the identifier for this class.
#
- # @param [Symbol] identifier The identifier to assign to this class.
+ # @param [Symbol, String] identifier The identifier to assign to this
+ # class.
#
# @return [void]
#
# @overload identifier
#
@@ -52,10 +55,10 @@
# @return [Enumerable<Class>] All classes of this type
def all
DDPlugin::Registry.instance.find_all(self)
end
- # @param [Symbol] identifier The identifier of the class to find
+ # @param [Symbol, String] identifier The identifier of the class to find
#
# @return [Class] The class with the given identifier
def named(identifier)
DDPlugin::Registry.instance.find(self, identifier)
end