diff options
author | Michal Sojka <michal.sojka@cvut.cz> | 2020-09-06 19:26:14 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-09-06 20:26:14 +0300 |
commit | 28f15390b97330ac8d653ea49008ef64e1eafb2b (patch) | |
tree | 007a76a5a148ce8e15e5f26412a1abf600656177 | |
parent | 49b3182748b8c38c56a4310b1843fbf93d0fe7cb (diff) | |
download | meson-28f15390b97330ac8d653ea49008ef64e1eafb2b.zip meson-28f15390b97330ac8d653ea49008ef64e1eafb2b.tar.gz meson-28f15390b97330ac8d653ea49008ef64e1eafb2b.tar.bz2 |
doc: Add missing method arguments [skip ci]
Documentation of most methods mentions method arguments enclosed in
parentheses. Two methods are an exception and we fix them here to make
the manual more consistent.
-rw-r--r-- | docs/markdown/Reference-manual.md | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md index af77771..fafc9cb 100644 --- a/docs/markdown/Reference-manual.md +++ b/docs/markdown/Reference-manual.md @@ -2155,27 +2155,27 @@ the following methods: `args` keyword, you can specify external dependencies to use with `dependencies` keyword argument. -- `check_header` *(since 0.47.0)*: returns true if the specified header is *usable* with - the specified prefix, dependencies, and arguments. - You can specify external dependencies to use with `dependencies` - keyword argument and extra code to put above the header test with - the `prefix` keyword. In order to look for headers in a specific - directory you can use `args : '-I/extra/include/dir`, but this - should only be used in exceptional cases for includes that can't be - detected via pkg-config and passed via `dependencies`. *(since 0.50.0)* The - `required` keyword argument can be used to abort if the header cannot be - found. - -- `has_header`: returns true if the specified header *exists*, and is - faster than `check_header()` since it only does a pre-processor check. - You can specify external dependencies to use with `dependencies` - keyword argument and extra code to put above the header test with - the `prefix` keyword. In order to look for headers in a specific - directory you can use `args : '-I/extra/include/dir`, but this - should only be used in exceptional cases for includes that can't be - detected via pkg-config and passed via `dependencies`. *(since 0.50.0)* The - `required` keyword argument can be used to abort if the header cannot be - found. +- `check_header(header_name)` *(since 0.47.0)*: returns true if the + specified header is *usable* with the specified prefix, + dependencies, and arguments. You can specify external dependencies + to use with `dependencies` keyword argument and extra code to put + above the header test with the `prefix` keyword. In order to look + for headers in a specific directory you can use `args : + '-I/extra/include/dir`, but this should only be used in exceptional + cases for includes that can't be detected via pkg-config and passed + via `dependencies`. *(since 0.50.0)* The `required` keyword argument + can be used to abort if the header cannot be found. + +- `has_header(header_name)`: returns true if the specified header + *exists*, and is faster than `check_header()` since it only does a + pre-processor check. You can specify external dependencies to use + with `dependencies` keyword argument and extra code to put above the + header test with the `prefix` keyword. In order to look for headers + in a specific directory you can use `args : '-I/extra/include/dir`, + but this should only be used in exceptional cases for includes that + can't be detected via pkg-config and passed via `dependencies`. + *(since 0.50.0)* The `required` keyword argument can be used to + abort if the header cannot be found. - `has_header_symbol(headername, symbolname)`: detects whether a particular symbol (function, variable, #define, type |