diff mbox series

[v2,2/2] doc: add events.h to documentation

Message ID 20230828191333.77249-3-heinrich.schuchardt@canonical.com
State Accepted, archived
Commit 91f19550d108b1b02c1d02ddbcb4d78cbdd299ce
Delegated to: Heinrich Schuchardt
Headers show
Series doc: event: document all events | expand

Commit Message

Heinrich Schuchardt Aug. 28, 2023, 7:13 p.m. UTC 
Add the events.h include to the API documentation.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
---
v2:
	no change
---
 doc/api/event.rst | 9 +++++++++
 doc/api/index.rst | 1 +
 2 files changed, 10 insertions(+)
 create mode 100644 doc/api/event.rst
diff mbox series

Patch

diff --git a/doc/api/event.rst b/doc/api/event.rst
new file mode 100644
index 0000000000..8a57d43832
--- /dev/null
+++ b/doc/api/event.rst
@@ -0,0 +1,9 @@ 
+.. SPDX-License-Identifier: GPL-2.0+
+
+Events
+======
+
+The concept of events is decribed :doc:`here <../develop/event>`.
+
+.. kernel-doc:: include/event.h
+   :internal:
diff --git a/doc/api/index.rst b/doc/api/index.rst
index 3a80ae0635..2f0218c47a 100644
--- a/doc/api/index.rst
+++ b/doc/api/index.rst
@@ -10,6 +10,7 @@  U-Boot API documentation
    dfu
    dm
    efi
+   event
    getopt
    linker_lists
    lmb