diff mbox series

[4/9] doc: add include/dm/platdata.h to the HTML documentation

Message ID 20220112105327.4.I57d9b7ea4afd35a375b32822d44dc3fe60eaebd1@changeid
State Accepted, archived
Commit ca4ca43e2f245a03b0953e723e38c49c676af78c
Delegated to: Heinrich Schuchardt
Headers show
Series [1/9] doc: add include/dm/uclass.h to the HTML documentation | expand

Commit Message

Patrick Delaunay Jan. 12, 2022, 9:53 a.m. UTC 
Correct Sphinx style comments in include/dm/platdata.h
and add the associated API to the HTML documentation.

Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
---

 doc/api/dm.rst        | 1 +
 include/dm/platdata.h | 4 ++--
 2 files changed, 3 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/api/dm.rst b/doc/api/dm.rst
index 168d129250..6f72b0b620 100644
--- a/doc/api/dm.rst
+++ b/doc/api/dm.rst
@@ -9,3 +9,4 @@  Uclass and Driver
 .. kernel-doc:: include/dm/uclass.h
 .. kernel-doc:: include/dm/root.h
 .. kernel-doc:: include/dm/lists.h
+.. kernel-doc:: include/dm/platdata.h
diff --git a/include/dm/platdata.h b/include/dm/platdata.h
index 4efb1dfe12..47ba8aab7a 100644
--- a/include/dm/platdata.h
+++ b/include/dm/platdata.h
@@ -40,7 +40,7 @@  struct driver_info {
 #endif
 
 /**
- * driver_rt - runtime information set up by U-Boot
+ * struct driver_rt - runtime information set up by U-Boot
  *
  * There is one of these for every driver_info in the linker list, indexed by
  * the driver_info idx value.
@@ -51,7 +51,7 @@  struct driver_rt {
 	struct udevice *dev;
 };
 
-/**
+/*
  * NOTE: Avoid using these except in extreme circumstances, where device tree
  * is not feasible (e.g. serial driver in SPL where <8KB of SRAM is
  * available). U-Boot's driver model uses device tree for configuration.