aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Reference-manual.md
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2017-12-02 22:17:21 +0200
committerJussi Pakkanen <jpakkane@gmail.com>2017-12-05 01:09:15 +0200
commitd3dcef7efc1df3b7a645eb6dc75c4a66a9131cb9 (patch)
treebbfdc29b9d8050b078ca8df01630a10d9260ad3e /docs/markdown/Reference-manual.md
parent678daad6cc11e850f5d7aa7f1744725d3acaf621 (diff)
downloadmeson-d3dcef7efc1df3b7a645eb6dc75c4a66a9131cb9.zip
meson-d3dcef7efc1df3b7a645eb6dc75c4a66a9131cb9.tar.gz
meson-d3dcef7efc1df3b7a645eb6dc75c4a66a9131cb9.tar.bz2
Added documentation for disabler objects.
Diffstat (limited to 'docs/markdown/Reference-manual.md')
-rw-r--r--docs/markdown/Reference-manual.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index e6aa9d3..ec5db03 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -319,6 +319,10 @@ otherwise. This function supports the following keyword arguments:
The returned object also has methods that are documented in the
[object methods section](#dependency-object) below.
+### disabler()
+
+Returns a [disabler object]((#disabler-object)). Added in 0.44.0.
+
### error()
``` meson
@@ -1627,6 +1631,15 @@ an external dependency with the following methods:
- `version()` is the version number as a string, for example `1.2.8`
+### `disabler` object
+
+A disabler object is an object that behaves in much the same way as
+NaN numbers do in floating point math. That is when used in any
+statement (function call, logical op, etc) they will cause the
+statement evaluation to immediately short circuit to return a disabler
+object. A disabler object has one method:
+
+ - `found()`, always returns `false`
### `external program` object