Commit Graph

17 Commits

Author SHA1 Message Date
Fabio Utzig
ce12936ce1 doc: update enumerator usage to :c:enumerator:
Following the change to use the C domain for parsing, update all
existing :cpp:enumerator: references to :c:enumerator:.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-08-31 09:57:33 -04:00
Fabio Utzig
c79d2ce794 doc: update struct references to use :c:struct:
Sphinx>=3.0 includes the `struct` role in the C domain, which provides a
specific way to link to structs, while the old :c:type: role should be
primary used to typedefs. Update existing references, using :c:type:,
:cpp:type: or emphasized symbols that point to structs to use the new
role.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-08-31 09:57:33 -04:00
Fabio Utzig
53fd5ff236 doc: update function references to use :c:func:
Following the change to use the C domain for parsing, update all
existing :cpp:func: references to :c:func:. Remove the parentheses as
well, if used, because they are not needed, this is already known to be
a function, and how it is displayed in the documentation later is a
semantic decision done by the output builder.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-08-31 09:57:33 -04:00
Ruth Fuchss
81a6107343 doc: add IDs to some sections
Add documentation IDs to some sections to be able
to directly link to them.

Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
2020-07-16 08:22:48 -04:00
Kamil Piszczek
a940bb1dbc doc: guides: bluetooth: updated persistent storage section
Updated the Persistent Storage section in the Bluetooth guide with NVS
configuration.

Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
2019-10-11 14:55:24 +02:00
Vinayak Kariappa Chettimada
f4eb03c538 Bluetooth: controller: Rename BT_LL_SW to BT_LL_SW_LEGACY
Rename the controller Kconfig option BT_LL_SW to
BT_LL_SW_LEGACY in preparation towards switch to new Link
Layer implementation.

Signed-off-by: Vinayak Kariappa Chettimada <vich@nordicsemi.no>
2019-07-22 14:23:42 +02:00
Anas Nashif
f2cb20c772 docs: fix misspelling across the tree
Found a few annoying typos and figured I better run script and
fix anything it can find, here are the results...

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-19 15:34:13 -05:00
Johan Hedberg
c5e826e8ff doc: bluetooth: Move L2CAP text from to API reference section
Move the L2CAP text from the guides section to the API reference
section.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
Johan Hedberg
bf31fbd789 doc: bluetooth: Move GATT text to API reference section
Move the GATT text from the guides section to the API reference.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
Johan Hedberg
d34128a97b doc: bluetooth: Add reference to Mesh API section
Add a reference from the architecture guide to the Mesh API section.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
Johan Hedberg
eb46f47a8d doc: bluetooth: Fix text corruption
For some reason there were garbage characters at the end of the line.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
Johan Hedberg
83b443aa2d doc: bluetooth: Move connection management text to API reference
Move the connection management text from the Guides section to the API
reference section.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
David B. Kinder
5d8e367efe doc: fix misspelling in docs and API comments
Fix misspellings missed during regular reviews.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-27 15:59:09 -04:00
Luiz Augusto von Dentz
269935dca9 doc: Bluetooth: Add initial documentation for the GATT layer
Add initial sections for GATT layer.

Signed-off-by: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
2019-03-13 10:40:05 +01:00
Luiz Augusto von Dentz
258cd01152 doc: Bluetooth: Add initial documentation for the L2CAP layer
Add initial sections for L2CAP layer.

Signed-off-by: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
2019-03-13 10:40:05 +01:00
Johan Hedberg
00cabc6381 doc: Bluetooth: Add initial guide for the host stack
Add initial sections for the Bluetooth host stack, as well as a simple
diagram of the various protocol & profile layers.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-03-13 10:40:05 +01:00
Carles Cufi
8f05a4c6d5 doc: Bluetooth: Documentation overhaul
Overhaul the Bluetooth documentation to split it into manageable units
and include additional information, such as architecture and tooling.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-03-13 10:40:05 +01:00