From 563b67a7bf7b0813f550cf24fffa376e9d0b94cf Mon Sep 17 00:00:00 2001 From: brettlangdon Date: Wed, 17 Jun 2015 19:44:00 -0400 Subject: [PATCH] add exported function comments --- forge.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/forge.go b/forge.go index 7fd0787..366e075 100644 --- a/forge.go +++ b/forge.go @@ -89,18 +89,22 @@ import ( "github.com/brettlangdon/forge/parser" ) +// Parse a forge SectionValue from a string func ParseString(data string) (*config.SectionValue, error) { return parser.ParseReader(strings.NewReader(data)) } +// Parse a forge SectionValue from a byte array func ParseBytes(data []byte) (*config.SectionValue, error) { return parser.ParseReader(bytes.NewReader(data)) } +// Parse a forge SectionValue from a filename func ParseFile(filename string) (*config.SectionValue, error) { return parser.ParseFile(filename) } +// Parse a forge SectionValue from a io.Reader func ParseReader(reader io.Reader) (*config.SectionValue, error) { return parser.ParseReader(reader) }