chore: prune boilerplate and refresh stale docs

- Remove 257 redundant per-definition comment stubs across the package
- Drop dead nonlocal declarations in autoslicer_detection.py
- Document the swapped flag and swap_left_right in architecture docs
- Remove unsupported 'legacy override' claims from autotune/runtime docs

scanslicer/controller_image_io.py

@@ -6,9 +6,7 @@ import numpy as np
 from PySide6.QtWidgets import QFileDialog, QMessageBox
 
 
-# ScanSlicerImageIOMixin: class definition for ScanSlicer behavior.
 class ScanSlicerImageIOMixin:
-    # resolve_directory_dialog_start_dir: function definition for ScanSlicer behavior.
     def resolve_directory_dialog_start_dir(self):
         if self.input_dir and os.path.isdir(self.input_dir):
             return self.input_dir
@@ -24,7 +22,6 @@ class ScanSlicerImageIOMixin:
             return home_dir
         return ""
 
-    # refresh_goto_image_dropdown: function definition for ScanSlicer behavior.
     def refresh_goto_image_dropdown(self):
         dropdown = getattr(self, "goto_image_dropdown", None)
         if dropdown is None:
@@ -38,7 +35,6 @@ class ScanSlicerImageIOMixin:
         dropdown.blockSignals(False)
         self.sync_goto_image_selection()
 
-    # sync_goto_image_selection: function definition for ScanSlicer behavior.
     def sync_goto_image_selection(self):
         dropdown = getattr(self, "goto_image_dropdown", None)
         if dropdown is None:
@@ -57,7 +53,6 @@ class ScanSlicerImageIOMixin:
         dropdown.setCurrentIndex(index)
         dropdown.blockSignals(False)
 
-    # goto_image_from_dropdown: function definition for ScanSlicer behavior.
     def goto_image_from_dropdown(self, index):
         if self.processing_busy:
             return
@@ -69,9 +64,7 @@ class ScanSlicerImageIOMixin:
         self.source_index = index
         self.show_current_image(new_image=True)
 
-    # sort_image_paths: function definition for ScanSlicer behavior.
     def sort_image_paths(self, image_paths):
-        # safe_mtime: function definition for ScanSlicer behavior.
         def safe_mtime(path):
             try:
                 return os.path.getmtime(path)
@@ -95,7 +88,6 @@ class ScanSlicerImageIOMixin:
             ),
         )
 
-    # show_current_image: function definition for ScanSlicer behavior.
     def show_current_image(self, new_image=True):
         if self.processing_busy:
             return
@@ -111,7 +103,6 @@ class ScanSlicerImageIOMixin:
             self.update_preview(new_image=new_image, run_detection=True)
             self.update_statusbar("Loaded " + self.source_images[self.source_index])
 
-    # load_image: function definition for ScanSlicer behavior.
     def load_image(self, move_index=0):
         if self.processing_busy:
             return
@@ -138,20 +129,16 @@ class ScanSlicerImageIOMixin:
 
         self.show_current_image(new_image=True)
 
-    # set_save_format: function definition for ScanSlicer behavior.
     def set_save_format(self, choice):
         self.save_format = choice
         self.update_quality_controls_state()
 
-    # set_jpg_quality: function definition for ScanSlicer behavior.
     def set_jpg_quality(self, value):
         self.jpg_quality = int(value)
 
-    # set_png_compression: function definition for ScanSlicer behavior.
     def set_png_compression(self, value):
         self.png_compression = int(value)
 
-    # update_quality_controls_state: function definition for ScanSlicer behavior.
     def update_quality_controls_state(self):
         jpeg_enabled = self.save_format == "jpg"
         png_enabled = self.save_format == "png"
@@ -162,7 +149,6 @@ class ScanSlicerImageIOMixin:
         self.png_compression_spinbox.setEnabled(png_enabled)
         self.png_compression_spinbox.setVisible(png_enabled)
 
-    # set_sort_mode: function definition for ScanSlicer behavior.
     def set_sort_mode(self, choice):
         mode = choice.lower()
         if mode not in ("name", "time"):
@@ -187,14 +173,12 @@ class ScanSlicerImageIOMixin:
 
         self.show_current_image(new_image=True)
 
-    # update_output_dir_label: function definition for ScanSlicer behavior.
     def update_output_dir_label(self):
         if self.output_dir:
             self.output_dir_label.setText(self.output_dir)
         else:
             self.output_dir_label.setText("(not set)")
 
-    # set_output_directory: function definition for ScanSlicer behavior.
     def set_output_directory(self, basedir=None):
         # QPushButton.clicked emits a bool; ignore it when this method is used as a slot.
         if isinstance(basedir, bool):
@@ -211,7 +195,6 @@ class ScanSlicerImageIOMixin:
         self.update_output_dir_label()
         self.update_statusbar("Output directory set to " + self.output_dir)
 
-    # save_all: function definition for ScanSlicer behavior.
     def save_all(self):
         if self.processing_busy:
             return
@@ -276,7 +259,6 @@ class ScanSlicerImageIOMixin:
                 self.append_status_log(f"Feedback save failed: {exc}")
             QMessageBox.information(self, "Slices saved", f"{total_saved} slices have been saved")
 
-    # open_directory: function definition for ScanSlicer behavior.
     def open_directory(self, basedir=None):
         if self.processing_busy:
             return
@@ -313,10 +295,8 @@ class ScanSlicerImageIOMixin:
         else:
             self.load_image(0)
 
-    # next_image: function definition for ScanSlicer behavior.
     def next_image(self):
         self.load_image(1)
 
-    # prev_image: function definition for ScanSlicer behavior.
     def prev_image(self):
         self.load_image(-1)