vendor/github.com/magiconair/properties/doc.go
changeset 265 05c40b36d3b2
parent 242 2a9ec03fe5a1
--- a/vendor/github.com/magiconair/properties/doc.go	Thu Sep 22 16:37:07 2022 +0200
+++ b/vendor/github.com/magiconair/properties/doc.go	Sat Feb 04 12:58:35 2023 +0100
@@ -1,4 +1,4 @@
-// Copyright 2018 Frank Schroeder. All rights reserved.
+// Copyright 2013-2022 Frank Schroeder. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
@@ -13,7 +13,7 @@
 //
 // To load a single properties file use MustLoadFile():
 //
-//   p := properties.MustLoadFile(filename, properties.UTF8)
+//	p := properties.MustLoadFile(filename, properties.UTF8)
 //
 // To load multiple properties files use MustLoadFiles()
 // which loads the files in the given order and merges the
@@ -23,25 +23,25 @@
 // Filenames can contain environment variables which are expanded
 // before loading.
 //
-//   f1 := "/etc/myapp/myapp.conf"
-//   f2 := "/home/${USER}/myapp.conf"
-//   p := MustLoadFiles([]string{f1, f2}, properties.UTF8, true)
+//	f1 := "/etc/myapp/myapp.conf"
+//	f2 := "/home/${USER}/myapp.conf"
+//	p := MustLoadFiles([]string{f1, f2}, properties.UTF8, true)
 //
 // All of the different key/value delimiters ' ', ':' and '=' are
 // supported as well as the comment characters '!' and '#' and
 // multi-line values.
 //
-//   ! this is a comment
-//   # and so is this
+//	! this is a comment
+//	# and so is this
 //
-//   # the following expressions are equal
-//   key value
-//   key=value
-//   key:value
-//   key = value
-//   key : value
-//   key = val\
-//         ue
+//	# the following expressions are equal
+//	key value
+//	key=value
+//	key:value
+//	key = value
+//	key : value
+//	key = val\
+//	      ue
 //
 // Properties stores all comments preceding a key and provides
 // GetComments() and SetComments() methods to retrieve and
@@ -55,62 +55,62 @@
 // and malformed expressions are not allowed and cause an
 // error. Expansion of environment variables is supported.
 //
-//   # standard property
-//   key = value
+//	# standard property
+//	key = value
 //
-//   # property expansion: key2 = value
-//   key2 = ${key}
+//	# property expansion: key2 = value
+//	key2 = ${key}
 //
-//   # recursive expansion: key3 = value
-//   key3 = ${key2}
+//	# recursive expansion: key3 = value
+//	key3 = ${key2}
 //
-//   # circular reference (error)
-//   key = ${key}
+//	# circular reference (error)
+//	key = ${key}
 //
-//   # malformed expression (error)
-//   key = ${ke
+//	# malformed expression (error)
+//	key = ${ke
 //
-//   # refers to the users' home dir
-//   home = ${HOME}
+//	# refers to the users' home dir
+//	home = ${HOME}
 //
-//   # local key takes precedence over env var: u = foo
-//   USER = foo
-//   u = ${USER}
+//	# local key takes precedence over env var: u = foo
+//	USER = foo
+//	u = ${USER}
 //
 // The default property expansion format is ${key} but can be
 // changed by setting different pre- and postfix values on the
 // Properties object.
 //
-//   p := properties.NewProperties()
-//   p.Prefix = "#["
-//   p.Postfix = "]#"
+//	p := properties.NewProperties()
+//	p.Prefix = "#["
+//	p.Postfix = "]#"
 //
 // Properties provides convenience functions for getting typed
 // values with default values if the key does not exist or the
 // type conversion failed.
 //
-//   # Returns true if the value is either "1", "on", "yes" or "true"
-//   # Returns false for every other value and the default value if
-//   # the key does not exist.
-//   v = p.GetBool("key", false)
+//	# Returns true if the value is either "1", "on", "yes" or "true"
+//	# Returns false for every other value and the default value if
+//	# the key does not exist.
+//	v = p.GetBool("key", false)
 //
-//   # Returns the value if the key exists and the format conversion
-//   # was successful. Otherwise, the default value is returned.
-//   v = p.GetInt64("key", 999)
-//   v = p.GetUint64("key", 999)
-//   v = p.GetFloat64("key", 123.0)
-//   v = p.GetString("key", "def")
-//   v = p.GetDuration("key", 999)
+//	# Returns the value if the key exists and the format conversion
+//	# was successful. Otherwise, the default value is returned.
+//	v = p.GetInt64("key", 999)
+//	v = p.GetUint64("key", 999)
+//	v = p.GetFloat64("key", 123.0)
+//	v = p.GetString("key", "def")
+//	v = p.GetDuration("key", 999)
 //
 // As an alternative properties may be applied with the standard
 // library's flag implementation at any time.
 //
-//   # Standard configuration
-//   v = flag.Int("key", 999, "help message")
-//   flag.Parse()
+//	# Standard configuration
+//	v = flag.Int("key", 999, "help message")
+//	flag.Parse()
 //
-//   # Merge p into the flag set
-//   p.MustFlag(flag.CommandLine)
+//	# Merge p into the flag set
+//	p.MustFlag(flag.CommandLine)
 //
 // Properties provides several MustXXX() convenience functions
 // which will terminate the app if an error occurs. The behavior
@@ -119,30 +119,30 @@
 // of logging the error set a different ErrorHandler before
 // you use the Properties package.
 //
-//   properties.ErrorHandler = properties.PanicHandler
+//	properties.ErrorHandler = properties.PanicHandler
 //
-//   # Will panic instead of logging an error
-//   p := properties.MustLoadFile("config.properties")
+//	# Will panic instead of logging an error
+//	p := properties.MustLoadFile("config.properties")
 //
 // You can also provide your own ErrorHandler function. The only requirement
 // is that the error handler function must exit after handling the error.
 //
-//   properties.ErrorHandler = func(err error) {
-//	     fmt.Println(err)
-//       os.Exit(1)
-//   }
+//	  properties.ErrorHandler = func(err error) {
+//		     fmt.Println(err)
+//	      os.Exit(1)
+//	  }
 //
-//   # Will write to stdout and then exit
-//   p := properties.MustLoadFile("config.properties")
+//	  # Will write to stdout and then exit
+//	  p := properties.MustLoadFile("config.properties")
 //
 // Properties can also be loaded into a struct via the `Decode`
 // method, e.g.
 //
-//   type S struct {
-//       A string        `properties:"a,default=foo"`
-//       D time.Duration `properties:"timeout,default=5s"`
-//       E time.Time     `properties:"expires,layout=2006-01-02,default=2015-01-01"`
-//   }
+//	type S struct {
+//	    A string        `properties:"a,default=foo"`
+//	    D time.Duration `properties:"timeout,default=5s"`
+//	    E time.Time     `properties:"expires,layout=2006-01-02,default=2015-01-01"`
+//	}
 //
 // See `Decode()` method for the full documentation.
 //
@@ -152,5 +152,4 @@
 // http://en.wikipedia.org/wiki/.properties
 //
 // http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#load%28java.io.Reader%29
-//
 package properties