diff options
author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:05:50 +0100 |
---|---|---|
committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:11:34 +0100 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /drivers/misc/cros_ec_sandbox.c | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) |
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>
Diffstat (limited to 'drivers/misc/cros_ec_sandbox.c')
-rw-r--r-- | drivers/misc/cros_ec_sandbox.c | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/drivers/misc/cros_ec_sandbox.c b/drivers/misc/cros_ec_sandbox.c index 2173517cff..8dbe0b188a 100644 --- a/drivers/misc/cros_ec_sandbox.c +++ b/drivers/misc/cros_ec_sandbox.c @@ -186,7 +186,7 @@ SANDBOX_STATE_IO(cros_ec, "google,cros-ec", cros_ec_read_state, * * @param ec Current emulated EC state * @param entry Flash map entry containing the image to check - * @return actual image size in bytes, 0 if the image contains no content or + * Return: actual image size in bytes, 0 if the image contains no content or * error. */ static int get_image_used(struct ec_state *ec, struct fmap_entry *entry) @@ -214,7 +214,7 @@ static int get_image_used(struct ec_state *ec, struct fmap_entry *entry) * * @param ec Current emulated EC state * @param node Keyboard node of device tree containing keyscan information - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int keyscan_read_fdt_matrix(struct ec_state *ec, ofnode node) { @@ -263,7 +263,7 @@ static int keyscan_read_fdt_matrix(struct ec_state *ec, ofnode node) * @param ec Current emulated EC state * @param scan Place to put keyscan bytes for the keyscan message (must hold * enough space for a full keyscan) - * @return number of bytes of valid scan data + * Return: number of bytes of valid scan data */ static int cros_ec_keyscan(struct ec_state *ec, uint8_t *scan) { @@ -305,7 +305,7 @@ static int cros_ec_keyscan(struct ec_state *ec, uint8_t *scan) * @param req_data Pointer to body of request * @param resp_hdr Pointer to place to put response header * @param resp_data Pointer to place to put response data, if any - * @return length of response data, or 0 for no response data, or -1 on error + * Return: length of response data, or 0 for no response data, or -1 on error */ static int process_cmd(struct ec_state *ec, struct ec_host_request *req_hdr, const void *req_data, |