aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSerge Aleynikov <[email protected]>2013-01-15 10:24:14 -0500
committerSerge Aleynikov <[email protected]>2013-01-15 12:10:04 -0500
commit37654ca0993d24753d6596f7a5e4e784030092c4 (patch)
treebd30824bbb0b0d9c39135a01d7d0ba2fd3a0026c
parent719e25ebda24db268cf94121c29258283e24b753 (diff)
downloadotp-37654ca0993d24753d6596f7a5e4e784030092c4.tar.gz
otp-37654ca0993d24753d6596f7a5e4e784030092c4.tar.bz2
otp-37654ca0993d24753d6596f7a5e4e784030092c4.zip
Moved documentation in a separate entry
-rw-r--r--lib/kernel/doc/src/application.xml13
1 files changed, 10 insertions, 3 deletions
diff --git a/lib/kernel/doc/src/application.xml b/lib/kernel/doc/src/application.xml
index 3513e2b592..9f19efc793 100644
--- a/lib/kernel/doc/src/application.xml
+++ b/lib/kernel/doc/src/application.xml
@@ -108,14 +108,12 @@
<func>
<name name="get_env" arity="1"/>
<name name="get_env" arity="2"/>
- <name name="get_env" arity="3"/>
<fsummary>Get the value of a configuration parameter</fsummary>
<desc>
<p>Returns the value of the configuration parameter <c><anno>Par</anno></c>
for <c><anno>Application</anno></c>. If the application argument is
omitted, it defaults to the application of the calling
- process. If <c><anno>Def</anno></c> value is provided, it is returned
- when no configuration parameter <c><anno>Par</anno></c> is defined.</p>
+ process.</p>
<p>If the specified application is not loaded, or
the configuration parameter does not exist, or if the process
executing the call does not belong to any application,
@@ -123,6 +121,15 @@
</desc>
</func>
<func>
+ <name name="get_env" arity="3"/>
+ <fsummary>Get the value of a configuration parameter using a default</fsummary>
+ <desc>
+ <p>Works like <seealso marker="#get_env/2">get_env/2</seealso> but returns
+ <c><anno>Def</anno></c> value when configuration parameter
+ <c><anno>Par</anno></c> does not exist.</p>
+ </desc>
+ </func>
+ <func>
<name name="get_key" arity="1"/>
<name name="get_key" arity="2"/>
<fsummary>Get the value of an application specification key</fsummary>