PM: hibernate: Clean up kernel-doc comment style usage

Several static functions in kernel/power/swap.c were described using the
kernel-doc comment style (/** ... */) even though they are not exported
or referenced by generated documentation. This led to kernel-doc warnings
and stylistic inconsistencies.

Convert these unnecessary kernel-doc blocks to regular C comments,
remove comment blocks that are no longer useful, relocate comments to
more appropriate positions where needed, and fix a few "Return:"
descriptions that were either missing or incorrectly formatted.

No functional changes.

Signed-off-by: Sunday Adelodun <adelodunolaoluwa@yahoo.com>
[ rjw: Subject adjustment, changelog edits, comment edits ]
Link: https://patch.msgid.link/20251114220438.52448-1-adelodunolaoluwa@yahoo.com
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

diff --git a/kernel/power/swap.c b/kernel/power/swap.c
index f532f49d82ac2ef15933811fbc53e20d8daea099..c7c2b89c9b2b8b6c3d176294427a38521da3c283 100644 (file)
--- a/kernel/power/swap.c
+++ b/kernel/power/swap.c
@@ -336,16 +336,14 @@ static int mark_swapfiles(struct swap_map_handle *handle, unsigned int flags)
  */
 unsigned int swsusp_header_flags;
 
-/**
- *     swsusp_swap_check - check if the resume device is a swap device
- *     and get its index (if so)
- *
- *     This is called before saving image
- */
 static int swsusp_swap_check(void)
 {
        int res;
 
+       /*
+        * Check if the resume device is a swap device and get its index (if so).
+        * This is called before saving the image.
+        */
        if (swsusp_resume_device)
                res = swap_type_of(swsusp_resume_device, swsusp_resume_block);
        else
@@ -362,13 +360,6 @@ static int swsusp_swap_check(void)
        return 0;
 }
 
-/**
- *     write_page - Write one page to given swap location.
- *     @buf:           Address we're writing.
- *     @offset:        Offset of the swap page we're writing to.
- *     @hb:            bio completion batch
- */
-
 static int write_page(void *buf, sector_t offset, struct hib_bio_batch *hb)
 {
        gfp_t gfp = GFP_NOIO | __GFP_NOWARN | __GFP_NORETRY;
@@ -527,10 +518,6 @@ static unsigned int hibernate_compression_threads = CMP_THREADS;
 #define CMP_MIN_RD_PAGES       1024
 #define CMP_MAX_RD_PAGES       8192
 
-/**
- *     save_image - save the suspend image data
- */
-
 static int save_image(struct swap_map_handle *handle,
                       struct snapshot_handle *snapshot,
                       unsigned int nr_to_write)
@@ -710,12 +697,6 @@ static int compress_threadfn(void *data)
        return 0;
 }
 
-/**
- * save_compressed_image - Save the suspend image data after compression.
- * @handle: Swap map handle to use for saving the image.
- * @snapshot: Image to read data from.
- * @nr_to_write: Number of pages to save.
- */
 static int save_compressed_image(struct swap_map_handle *handle,
                                 struct snapshot_handle *snapshot,
                                 unsigned int nr_to_write)
@@ -943,13 +924,6 @@ out_clean:
        return ret;
 }
 
-/**
- *     enough_swap - Make sure we have enough swap to save the image.
- *
- *     Returns TRUE or FALSE after checking the total amount of swap
- *     space available from the resume partition.
- */
-
 static int enough_swap(unsigned int nr_pages)
 {
        unsigned int free_swap = count_swap_pages(root_swap, 1);
@@ -969,8 +943,9 @@ static int enough_swap(unsigned int nr_pages)
  *     them synced (in case something goes wrong) but we DO not want to mark
  *     filesystem clean: it is not. (And it does not matter, if we resume
  *     correctly, we'll mark system clean, anyway.)
+ *
+ *     Return: 0 on success, negative error code on failure.
  */
-
 int swsusp_write(unsigned int flags)
 {
        struct swap_map_handle handle;
@@ -1116,12 +1091,6 @@ static int swap_reader_finish(struct swap_map_handle *handle)
        return 0;
 }
 
-/**
- *     load_image - load the image using the swap map handle
- *     @handle and the snapshot handle @snapshot
- *     (assume there are @nr_pages pages to load)
- */
-
 static int load_image(struct swap_map_handle *handle,
                       struct snapshot_handle *snapshot,
                       unsigned int nr_to_read)
@@ -1229,12 +1198,6 @@ static int decompress_threadfn(void *data)
        return 0;
 }
 
-/**
- * load_compressed_image - Load compressed image data and decompress it.
- * @handle: Swap map handle to use for loading data.
- * @snapshot: Image to copy uncompressed data into.
- * @nr_to_read: Number of pages to load.
- */
 static int load_compressed_image(struct swap_map_handle *handle,
                                 struct snapshot_handle *snapshot,
                                 unsigned int nr_to_read)
@@ -1564,8 +1527,9 @@ out_clean:
  *     swsusp_read - read the hibernation image.
  *     @flags_p: flags passed by the "frozen" kernel in the image header should
  *               be written into this memory location
+ *
+ *     Return: 0 on success, negative error code on failure.
  */
-
 int swsusp_read(unsigned int *flags_p)
 {
        int error;
@@ -1602,8 +1566,9 @@ static void *swsusp_holder;
 /**
  * swsusp_check - Open the resume device and check for the swsusp signature.
  * @exclusive: Open the resume device exclusively.
+ *
+ * Return: 0 if a valid image is found, negative error code otherwise.
  */
-
 int swsusp_check(bool exclusive)
 {
        void *holder = exclusive ? &swsusp_holder : NULL;
@@ -1666,8 +1631,9 @@ void swsusp_close(void)
 
 /**
  *      swsusp_unmark - Unmark swsusp signature in the resume device
+ *
+ *      Return: 0 on success, negative error code on failure.
  */
-
 #ifdef CONFIG_SUSPEND
 int swsusp_unmark(void)
 {