Added more API documentation and minor changes

This commit is contained in:
David Allen 2024-07-08 18:18:16 -06:00
parent cd840b2bf0
commit 1d862ebd8c
No known key found for this signature in database
GPG key ID: 717C593FF60A2ACC
15 changed files with 117 additions and 48 deletions

View file

@ -24,11 +24,11 @@ func (g *Example) GetDescription() string {
return fmt.Sprintf("Configurator generator plugin for '%s'.", g.GetName())
}
func (g *Example) Generate(config *configurator.Config, opts ...util.Option) (generator.Files, error) {
func (g *Example) Generate(config *configurator.Config, opts ...util.Option) (generator.FileMap, error) {
g.Message = `
This is an example generator plugin. See the file in 'internal/generator/plugins/example/example.go' on
information about constructing plugins and plugin requirements.`
return generator.Files{"example": []byte(g.Message)}, nil
return generator.FileMap{"example": []byte(g.Message)}, nil
}
var Generator Example