Updated documentation about returned values.
authorStanislaw Klekot <dozzie@jarowit.net>
Sun, 17 Aug 2014 23:06:19 +0000 (01:06 +0200)
committerStanislaw Klekot <dozzie@jarowit.net>
Sun, 17 Aug 2014 23:06:19 +0000 (01:06 +0200)
src/eni.erl

index 2508458..3de845b 100644 (file)
@@ -1,6 +1,14 @@
 %%%---------------------------------------------------------------------------
 %%% @doc
 %%%   INI-like config loader.
+%%%
+%%%   Configuration returned by the functions from this module are simple
+%%%   proplists with atoms being the keys and strings (or Erlang terms) being
+%%%   the values. Named sections are gathered similar, into a proplist with
+%%%   atom keys (the value is, of course, a proplist with section's content).
+%%%
+%%%   Multiple value occurrences result in multiple entries in proplist,
+%%%   preserving the occurrence order.
 %%% @end
 %%%---------------------------------------------------------------------------