From ca4ca43e2f245a03b0953e723e38c49c676af78c Mon Sep 17 00:00:00 2001 From: Patrick Delaunay Date: Wed, 12 Jan 2022 10:53:45 +0100 Subject: [PATCH] doc: add include/dm/platdata.h to the HTML documentation Correct Sphinx style comments in include/dm/platdata.h and add the associated API to the HTML documentation. Signed-off-by: Patrick Delaunay Reviewed-by: Heinrich Schuchardt --- doc/api/dm.rst | 1 + include/dm/platdata.h | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/dm.rst b/doc/api/dm.rst index 168d129..6f72b0b 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 4efb1df..47ba8aa 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. -- 2.7.4