formats.javaProperties: Add documentation
This commit is contained in:
parent
9a0739cbe2
commit
28a227a890
@ -32,6 +32,20 @@ type of this option should represent the format. The most common formats
|
|||||||
have a predefined type and string generator already declared under
|
have a predefined type and string generator already declared under
|
||||||
`pkgs.formats`:
|
`pkgs.formats`:
|
||||||
|
|
||||||
|
`pkgs.formats.javaProperties` { *`comment`* ? `"Generated with Nix"` }
|
||||||
|
|
||||||
|
: A function taking an attribute set with values
|
||||||
|
|
||||||
|
`comment`
|
||||||
|
|
||||||
|
: A string to put at the start of the
|
||||||
|
file in a comment. It can have multiple
|
||||||
|
lines.
|
||||||
|
|
||||||
|
It returns the `type`: `attrsOf str` and a function
|
||||||
|
`generate` to build a Java `.properties` file, taking
|
||||||
|
care of the correct escaping, etc.
|
||||||
|
|
||||||
`pkgs.formats.json` { }
|
`pkgs.formats.json` { }
|
||||||
|
|
||||||
: A function taking an empty attribute set (for future extensibility)
|
: A function taking an empty attribute set (for future extensibility)
|
||||||
|
@ -53,6 +53,38 @@
|
|||||||
<literal>pkgs.formats</literal>:
|
<literal>pkgs.formats</literal>:
|
||||||
</para>
|
</para>
|
||||||
<variablelist>
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<literal>pkgs.formats.javaProperties</literal> {
|
||||||
|
<emphasis><literal>comment</literal></emphasis> ?
|
||||||
|
<literal>"Generated with Nix"</literal> }
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
A function taking an attribute set with values
|
||||||
|
</para>
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term>
|
||||||
|
<literal>comment</literal>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
A string to put at the start of the file in a comment.
|
||||||
|
It can have multiple lines.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
<para>
|
||||||
|
It returns the <literal>type</literal>:
|
||||||
|
<literal>attrsOf str</literal> and a function
|
||||||
|
<literal>generate</literal> to build a Java
|
||||||
|
<literal>.properties</literal> file, taking care of the
|
||||||
|
correct escaping, etc.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term>
|
<term>
|
||||||
<literal>pkgs.formats.json</literal> { }
|
<literal>pkgs.formats.json</literal> { }
|
||||||
|
Loading…
Reference in New Issue
Block a user