diff options
| author | David Lechner <david@lechnology.com> | 2021-06-24 12:44:01 -0500 |
|---|---|---|
| committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2021-06-24 13:11:27 -0700 |
| commit | b3451a205f0d0ed8a59b6d340d23d16e7a8d8248 (patch) | |
| tree | f627e72f4a844ac01f9fa8c978c80c430afdf461 /doc | |
| parent | 9b9da91979cdde7c3bee20adbbf4d702dd3e745b (diff) | |
| download | bluez-b3451a205f0d0ed8a59b6d340d23d16e7a8d8248.tar.gz | |
doc/advmon-api: Clarify Patterns property
The Patterns property description was not as clear as it could be. This
expands the text a bit, replaces the C enum value 0x01 with the D-Bus
property string value "or_patterns" and improves the grammar in a few
places.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/advertisement-monitor-api.txt | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/advertisement-monitor-api.txt b/doc/advertisement-monitor-api.txt index 8100717c0..9189f2cce 100644 --- a/doc/advertisement-monitor-api.txt +++ b/doc/advertisement-monitor-api.txt @@ -105,10 +105,11 @@ Properties string Type [read-only] array{(uint8, uint8, array{byte})} Patterns [read-only, optional] - If Type is set to 0x01, this must exist and has at least - one entry in the array. + If the Type property is set to "or_patterns", then this + property must exist and have at least one entry in the + array. - The structure of a pattern contains the following. + The structure of a pattern contains the following: uint8 start_position The index in an AD data field where the search should start. The beginning of an AD data field |