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>

diff --git a/doc/api/dm.rst b/doc/api/dm.rst
index 181a454c2454716bf503e3f3e24337e72e097afc..168d129250c25a83631a7f835aa52da12bf055ea 100644 (file)
--- 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 5896ae36583b222e60fdd648c9e30e6a514e8700..fc3b4ae58500c5cc857b0ea9f6743a7b7b9affed 100644 (file)
--- 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,