Doc fix for admission/plugin.go

Complete unfinished doc, changed some comments to be more readable.
This commit is contained in:
hurf 2015-09-09 21:23:03 +08:00
parent 9351ef36fe
commit 7b4f91c4ee

View File

@ -37,7 +37,7 @@ var (
plugins = make(map[string]Factory) plugins = make(map[string]Factory)
) )
// GetPlugins enumerates the // GetPlugins enumerates the names of all registered plugins.
func GetPlugins() []string { func GetPlugins() []string {
pluginsMutex.Lock() pluginsMutex.Lock()
defer pluginsMutex.Unlock() defer pluginsMutex.Unlock()
@ -61,11 +61,10 @@ func RegisterPlugin(name string, plugin Factory) {
plugins[name] = plugin plugins[name] = plugin
} }
// GetPlugin creates an instance of the named plugin, or nil if // GetPlugin creates an instance of the named plugin, or nil if the name is not
// the name is not known. The error return is only used if the named provider // known. The error is returned only when the named provider was known but failed
// was known but failed to initialize. The config parameter specifies the // to initialize. The config parameter specifies the io.Reader handler of the
// io.Reader handler of the configuration file for the cloud provider, or nil // configuration file for the cloud provider, or nil for no configuration.
// for no configuration.
func GetPlugin(name string, client client.Interface, config io.Reader) (Interface, error) { func GetPlugin(name string, client client.Interface, config io.Reader) (Interface, error) {
pluginsMutex.Lock() pluginsMutex.Lock()
defer pluginsMutex.Unlock() defer pluginsMutex.Unlock()