Skip to content

Commit e62f417

Browse files
committed
Add documentation for INI model
1 parent abf5181 commit e62f417

File tree

1 file changed

+15
-0
lines changed
  • peel-core/src/main/scala/org/peelframework/core/config

1 file changed

+15
-0
lines changed

peel-core/src/main/scala/org/peelframework/core/config/Model.scala

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,21 @@ object Model {
7777
}
7878
}
7979

80+
/** A model for INI type configuration files (e.g. etc/hadoop/container-executor.xml).
81+
*
82+
* Consists of a single entry `sections` which is constructed by collecting
83+
* all direct children under the specified `prefix` path. Each child
84+
* represents a section in the INI file and collects the (key, value) pairs
85+
* below it.
86+
*
87+
* (key, value) pairs that should not appear in a section have to be
88+
* listed under the child with a special name "_root_" (without quotes).
89+
*
90+
* See https://en.wikipedia.org/wiki/INI_file for details.
91+
*
92+
* @param c The HOCON config to use when constructing the model.
93+
* @param prefix The prefix path which has to be rendered.
94+
*/
8095
class INI(val c: Config, val prefix: String) extends Model {
8196

8297
val sections = {

0 commit comments

Comments
 (0)