colin/u-boot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: add include/dm/platdata.h to the HTML documentation

Browse Source 
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>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Patrick Delaunay
2022-01-12 10:53:45 +01:00
committed by Heinrich Schuchardt
parent cbb14ac92c
commit ca4ca43e2f
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/api/dm.rst
View File

@@ -9,3 +9,4 @@ Uclass and Driver
.. kernel-doc:: include/dm/uclass.h .. kernel-doc:: include/dm/uclass.h
.. kernel-doc:: include/dm/root.h .. kernel-doc:: include/dm/root.h
.. kernel-doc:: include/dm/lists.h .. kernel-doc:: include/dm/lists.h
.. kernel-doc:: include/dm/platdata.h

4
include/dm/platdata.h
View File

@@ -40,7 +40,7 @@ struct driver_info {
#endif #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 * There is one of these for every driver_info in the linker list, indexed by
* the driver_info idx value. * the driver_info idx value.
@@ -51,7 +51,7 @@ struct driver_rt {
struct udevice *dev; struct udevice *dev;
}; };
/** /*
* NOTE: Avoid using these except in extreme circumstances, where device tree * 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 * 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. * available). U-Boot's driver model uses device tree for configuration.