mirror of
https://xff.cz/git/u-boot/
synced 2025-11-01 10:56:02 +01:00
doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
@@ -89,7 +89,7 @@ void uclass_set_priv(struct uclass *uc, void *priv);
|
||||
* This allows assigning the sequence number in the binding order.
|
||||
*
|
||||
* @uc: uclass to check
|
||||
* @return The next free sequence number
|
||||
* Return: The next free sequence number
|
||||
*/
|
||||
int uclass_find_next_free_seq(struct uclass *uc);
|
||||
|
||||
@@ -101,7 +101,7 @@ int uclass_find_next_free_seq(struct uclass *uc);
|
||||
* @dev: Device that needs to be probed
|
||||
* @ret: Error to return. If non-zero then the device is not probed
|
||||
* @devp: Returns the value of 'dev' if there is no error
|
||||
* @return ret, if non-zero, else the result of the device_probe() call
|
||||
* Return: ret, if non-zero, else the result of the device_probe() call
|
||||
*/
|
||||
int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp);
|
||||
|
||||
@@ -112,7 +112,7 @@ int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp);
|
||||
*
|
||||
* The device is not prepared for use - this is an internal function.
|
||||
*
|
||||
* @return the index of the device in the uclass list or -ENODEV if not found.
|
||||
* Return: the index of the device in the uclass list or -ENODEV if not found.
|
||||
*/
|
||||
int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp);
|
||||
|
||||
@@ -125,7 +125,7 @@ int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp);
|
||||
* The device is not prepared for use - this is an internal function.
|
||||
* The function uclass_get_device_tail() can be used to probe the device.
|
||||
*
|
||||
* @return the uclass pointer of a child at the given index or
|
||||
* Return: the uclass pointer of a child at the given index or
|
||||
* return NULL on error.
|
||||
*/
|
||||
int uclass_find_device(enum uclass_id id, int index, struct udevice **devp);
|
||||
@@ -138,7 +138,7 @@ int uclass_find_device(enum uclass_id id, int index, struct udevice **devp);
|
||||
* The device is not prepared for use - this is an internal function.
|
||||
* The function uclass_get_device_tail() can be used to probe the device.
|
||||
*
|
||||
* @return 0 if OK (found or not found), -ve on error
|
||||
* Return: 0 if OK (found or not found), -ve on error
|
||||
*/
|
||||
int uclass_find_first_device(enum uclass_id id, struct udevice **devp);
|
||||
|
||||
@@ -150,7 +150,7 @@ int uclass_find_first_device(enum uclass_id id, struct udevice **devp);
|
||||
* The device is not prepared for use - this is an internal function.
|
||||
* The function uclass_get_device_tail() can be used to probe the device.
|
||||
*
|
||||
* @return 0 if OK (found or not found), -ve on error
|
||||
* Return: 0 if OK (found or not found), -ve on error
|
||||
*/
|
||||
int uclass_find_next_device(struct udevice **devp);
|
||||
|
||||
@@ -164,7 +164,7 @@ int uclass_find_next_device(struct udevice **devp);
|
||||
* @id: ID to look up
|
||||
* @name: name of a device to find
|
||||
* @devp: Returns pointer to device (the first one with the name)
|
||||
* @return 0 if OK, -ve on error
|
||||
* Return: 0 if OK, -ve on error
|
||||
*/
|
||||
int uclass_find_device_by_name(enum uclass_id id, const char *name,
|
||||
struct udevice **devp);
|
||||
@@ -179,7 +179,7 @@ int uclass_find_device_by_name(enum uclass_id id, const char *name,
|
||||
* @id: ID to look up
|
||||
* @seq: Sequence number to find (0=first)
|
||||
* @devp: Returns pointer to device (there is only one per for each seq)
|
||||
* @return 0 if OK, -ENODEV if not found
|
||||
* Return: 0 if OK, -ENODEV if not found
|
||||
*/
|
||||
int uclass_find_device_by_seq(enum uclass_id id, int seq,
|
||||
struct udevice **devp);
|
||||
@@ -195,7 +195,7 @@ int uclass_find_device_by_seq(enum uclass_id id, int seq,
|
||||
* @id: ID to look up
|
||||
* @node: Device tree offset to search for (if -ve then -ENODEV is returned)
|
||||
* @devp: Returns pointer to device (there is only one for each node)
|
||||
* @return 0 if OK, -ve on error
|
||||
* Return: 0 if OK, -ve on error
|
||||
*/
|
||||
int uclass_find_device_by_of_offset(enum uclass_id id, int node,
|
||||
struct udevice **devp);
|
||||
@@ -211,7 +211,7 @@ int uclass_find_device_by_of_offset(enum uclass_id id, int node,
|
||||
* @id: ID to look up
|
||||
* @node: Device tree offset to search for (if NULL then -ENODEV is returned)
|
||||
* @devp: Returns pointer to device (there is only one for each node)
|
||||
* @return 0 if OK, -ve on error
|
||||
* Return: 0 if OK, -ve on error
|
||||
*/
|
||||
int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
|
||||
struct udevice **devp);
|
||||
@@ -227,7 +227,7 @@ int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
|
||||
* @parent: Parent device containing the phandle pointer
|
||||
* @name: Name of property in the parent device node
|
||||
* @devp: Returns pointer to device (there is only one for each node)
|
||||
* @return 0 if OK, -ENOENT if there is no @name present in the node, other
|
||||
* Return: 0 if OK, -ENOENT if there is no @name present in the node, other
|
||||
* -ve on error
|
||||
*/
|
||||
int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
|
||||
@@ -317,7 +317,7 @@ int uclass_get_count(void);
|
||||
* uclass_find() - Find uclass by its id
|
||||
*
|
||||
* @id: Id to serach for
|
||||
* @return pointer to uclass, or NULL if not found
|
||||
* Return: pointer to uclass, or NULL if not found
|
||||
*/
|
||||
struct uclass *uclass_find(enum uclass_id key);
|
||||
|
||||
@@ -327,7 +327,7 @@ struct uclass *uclass_find(enum uclass_id key);
|
||||
* Destroy a uclass and all its devices
|
||||
*
|
||||
* @uc: uclass to destroy
|
||||
* @return 0 on success, -ve on error
|
||||
* Return: 0 on success, -ve on error
|
||||
*/
|
||||
int uclass_destroy(struct uclass *uc);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user