Correct Sphinx style comments in include/dm/read.h
and add the device read from device tree API to the HTML
documentation.
Signed-off-by: Patrick Delaunay
---
doc/api/dm.rst| 1 +
include/dm/read.h | 163 +++---
2 files changed, 82 insertions(+), 82 deletions(-)
diff --git a/doc/api/dm.rst b/doc/api/dm.rst
index 0342620786..19a473f1f0 100644
--- a/doc/api/dm.rst
+++ b/doc/api/dm.rst
@@ -16,3 +16,4 @@ Device
.. kernel-doc:: include/dm/device.h
.. kernel-doc:: include/dm/devres.h
+.. kernel-doc:: include/dm/read.h
diff --git a/include/dm/read.h b/include/dm/read.h
index 75c6ad6ee4..18b84905f4 100644
--- a/include/dm/read.h
+++ b/include/dm/read.h
@@ -37,7 +37,7 @@ static inline const struct device_node *dev_np(const struct
udevice *dev)
* @dev: device to read DT property from
* @propname: name of the property to read from
* @outp: place to put value (if found)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dev_read_u32(const struct udevice *dev, const char *propname, u32 *outp);
@@ -47,7 +47,7 @@ int dev_read_u32(const struct udevice *dev, const char
*propname, u32 *outp);
* @dev: device to read DT property from
* @propname: name of the property to read from
* @def: default value to return if the property has no value
- * @return property value, or @def if not found
+ * Return: property value, or @def if not found
*/
int dev_read_u32_default(const struct udevice *dev, const char *propname,
int def);
@@ -60,7 +60,7 @@ int dev_read_u32_default(const struct udevice *dev, const
char *propname,
* @propname: name of the property to read from
* @index: index of the integer to return
* @outp: place to put value (if found)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dev_read_u32_index(struct udevice *dev, const char *propname, int index,
u32 *outp);
@@ -73,7 +73,7 @@ int dev_read_u32_index(struct udevice *dev, const char
*propname, int index,
* @propname: name of the property to read from
* @index: index of the integer to return
* @def: default value to return if the property has no value
- * @return property value, or @def if not found
+ * Return: property value, or @def if not found
*/
u32 dev_read_u32_index_default(struct udevice *dev, const char *propname,
int index, u32 def);
@@ -84,7 +84,7 @@ u32 dev_read_u32_index_default(struct udevice *dev, const
char *propname,
* @dev: device to read DT property from
* @propname: name of the property to read from
* @outp: place to put value (if found)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dev_read_s32(const struct udevice *dev, const char *propname, s32 *outp);
@@ -94,7 +94,7 @@ int dev_read_s32(const struct udevice *dev, const char
*propname, s32 *outp);
* @dev: device to read DT property from
* @propname: name of the property to read from
* @def: default value to return if the property has no value
- * @return property value, or @def if not found
+ * Return: property value, or @def if not found
*/
int dev_read_s32_default(const struct udevice *dev, const char *propname,
int def);
@@ -107,7 +107,7 @@ int dev_read_s32_default(const struct udevice *dev, const
char *propname,
* @dev: device to read DT property from
* @propname: name of the property to read from
* @outp: place to put value (if found)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dev_read_u32u(const struct udevice *dev, const char *propname, uint *outp);
@@ -117,7 +117,7 @@ int dev_read_u32u(const struct udevice *dev, const char
*propname, uint *outp);
* @dev:device to read DT property from
* @propname: name of the property to read from
* @outp: place to put value (if found)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dev_read_u64(const struct udevice *dev, const char *propname, u64 *outp);
@@ -127,7 +127,7 @@ int dev_read_u64(const struct udevice *dev, const char
*propname, u64 *outp);
* @dev:device to read DT property from
* @propname: name of the property to read from
* @def:default value to return if the property has no value
- * @return property value, or @def if not found
+ * Return: property value, or @def if not found
*/
u64 dev_read_u64_default(const struct udevice *dev, const char *propname,
u64 def);
@@ -137,7 +137,7 @@ u64 dev_read_u64_default(const struct udevice *dev, const
char *propname,
*
* @dev: device to read DT property from
* @propname: name of the property to read
- * @return string from property value, or NULL if there is no such property
+ * Return: string from property value, or NULL if there is no such property
*/
const
