diff options
| author | Patrick Delaunay <patrick.delaunay@foss.st.com> | 2022-01-12 10:53:44 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-15 10:57:21 +0100 |
| commit | cbb14ac92c1a40201aae0328b3af690dff133ecd (patch) | |
| tree | 59597dce97213f9636c993d4236a51e2ebdf1431 | |
| parent | 0cdd7ded8887d41d83f518e7b352972e58b47a1e (diff) | |
| download | u-boot-cbb14ac92c1a40201aae0328b3af690dff133ecd.tar.gz u-boot-cbb14ac92c1a40201aae0328b3af690dff133ecd.tar.bz2 u-boot-cbb14ac92c1a40201aae0328b3af690dff133ecd.zip | |
doc: add include/dm/lists.h to the HTML documentation
Correct Sphinx style comments in include/dm/lists.h
and add the list API to the HTML documentation.
Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
| -rw-r--r-- | doc/api/dm.rst | 1 | ||||
| -rw-r--r-- | include/dm/lists.h | 8 |
2 files changed, 6 insertions, 3 deletions
diff --git a/doc/api/dm.rst b/doc/api/dm.rst index 181a454c24..168d129250 100644 --- a/doc/api/dm.rst +++ b/doc/api/dm.rst @@ -8,3 +8,4 @@ Uclass and Driver .. kernel-doc:: include/dm/uclass.h .. kernel-doc:: include/dm/root.h +.. kernel-doc:: include/dm/lists.h diff --git a/include/dm/lists.h b/include/dm/lists.h index 5896ae3658..fc3b4ae585 100644 --- a/include/dm/lists.h +++ b/include/dm/lists.h @@ -19,13 +19,14 @@ * for binding a driver given its name and plat. * * @name: Name of driver to look up - * @return pointer to driver, or NULL if not found + * Return: pointer to driver, or NULL if not found */ struct driver *lists_driver_lookup_name(const char *name); /** * lists_uclass_lookup() - Return uclass_driver based on ID of the class - * id: ID of the class + * + * @id: ID of the class * * This function returns the pointer to uclass_driver, which is the class's * base structure based on the ID of the class. Returns NULL on error. @@ -56,7 +57,8 @@ int lists_bind_drivers(struct udevice *parent, bool pre_reloc_only); * @drv: if non-NULL, force this driver to be bound * @pre_reloc_only: If true, bind only nodes with special devicetree properties, * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers. - * @return 0 if device was bound, -EINVAL if the device tree is invalid, + * + * Return: 0 if device was bound, -EINVAL if the device tree is invalid, * other -ve value on error */ int lists_bind_fdt(struct udevice *parent, ofnode node, struct udevice **devp, |