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.
pull/7671/head
Michal Sojka 4 years ago committed by GitHub
parent 49b3182748
commit 28f15390b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 42
      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

Loading…
Cancel
Save