michaelh/zephyr
1
0
Fork 0
Code Releases Activity

samples: bindesc: doc: Describe sample using zephyr:code-sample

Browse source 
Describe the code sample using zephyr:code-sample directive to help
with making it easier to find from API reference.
Also cross-referenced main bindesc page from the sample.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-09-28 14:20:15 +02:00 • committed by Johan Hedberg
commit 79674debcb
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
samples/subsys/bindesc/hello_bindesc/README.rst
View file

@ -1,12 +1,13 @@
.. _hello_bindesc-sample: .. zephyr:code-sample:: hello-bindesc
:name: Binary descriptors "Hello World"
:relevant-api: bindesc_define
hello_bindesc Sample Application Set and access binary descriptors for a basic Zephyr application.
################################
Overview Overview
******** ********
A simple sample of binary descriptor definition and usage. A simple sample of :ref:`binary descriptor <binary_descriptors>` definition and usage.
Building and Running Building and Running
******************** ********************