Mercurial > irccd
annotate doc/src/api/module/Irccd.System/Irccd.System.env.md @ 607:bb9771fb5f44
Docs: rework documentation
- Change directories,
- Remove handwritten manual pages.
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 08 Dec 2017 20:11:22 +0100 |
parents | doc/html/api/module/Irccd.System/Irccd.System.env.md@48676ca7071c |
children | ebdc614db066 |
rev | line source |
---|---|
263
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 --- |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 function: env |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 js: true |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 summary: "Get a environment variable." |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 synopsis: "home = Irccd.System.env(name)" |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 arguments: |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 - "**name**: the environment variable name." |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 returns: "The variable or an empty string." |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 --- |