docs: add missing class doc strings for rpc-enabled widgets

bec_widgets/cli/client.py

@@ -240,6 +240,8 @@ class BECDock(RPCBase):
 
 
 class BECDockArea(RPCBase):
+    """Container for other widgets. Widgets can be added to the dock area and arranged in a grid layout."""
+
     @property
     @rpc_call
     def _rpc_id(self) -> "str":
@@ -660,6 +662,8 @@ class DapComboBox(RPCBase):
 
 
 class DeviceBrowser(RPCBase):
+    """DeviceBrowser is a widget that displays all available devices in the current BEC session."""
+
     @rpc_call
     def remove(self):
         """
@@ -698,6 +702,8 @@ class DeviceLineEdit(RPCBase):
 
 
 class Image(RPCBase):
+    """Image widget for displaying 2D data."""
+
     @property
     @rpc_call
     def enable_toolbar(self) -> "bool":
@@ -1379,6 +1385,8 @@ class LogPanel(RPCBase):
 
 
 class MotorMap(RPCBase):
+    """Motor map widget for plotting motor positions in 2D including a trace of the last points."""
+
     @property
     @rpc_call
     def enable_toolbar(self) -> "bool":
@@ -1768,6 +1776,8 @@ class MotorMap(RPCBase):
 
 
 class MultiWaveform(RPCBase):
+    """MultiWaveform widget for displaying multiple waveforms emitted by a single signal."""
+
     @property
     @rpc_call
     def enable_toolbar(self) -> "bool":
@@ -2177,6 +2187,8 @@ class MultiWaveform(RPCBase):
 
 
 class PositionIndicator(RPCBase):
+    """Display a position within a defined range, e.g. motor limits."""
+
     @rpc_call
     def set_value(self, position: float):
         """
@@ -2328,6 +2340,8 @@ class Ring(RPCBase):
 
 
 class RingProgressBar(RPCBase):
+    """Show the progress of devices, scans or custom values in the form of ring progress bars."""
+
     @rpc_call
     def _get_all_rpc(self) -> "dict":
         """
@@ -2507,6 +2521,8 @@ class RingProgressBar(RPCBase):
 
 
 class ScanControl(RPCBase):
+    """Widget to submit new scans to the queue."""
+
     @rpc_call
     def remove(self):
         """
@@ -2896,6 +2912,8 @@ class VSCodeEditor(RPCBase):
 
 
 class Waveform(RPCBase):
+    """Widget for plotting waveforms."""
+
     @property
     @rpc_call
     def _config_dict(self) -> "dict":

bec_widgets/widgets/containers/dock/dock_area.py

@@ -48,6 +48,10 @@ class DockAreaConfig(ConnectionConfig):
 
 
 class BECDockArea(BECWidget, QWidget):
+    """
+    Container for other widgets. Widgets can be added to the dock area and arranged in a grid layout.
+    """
+
     PLUGIN = True
     USER_ACCESS = [
         "_rpc_id",

bec_widgets/widgets/control/device_control/position_indicator/position_indicator.py

@@ -8,6 +8,10 @@ from bec_widgets.utils.colors import get_accent_colors, get_theme_palette
 
 
 class PositionIndicator(BECWidget, QWidget):
+    """
+    Display a position within a defined range, e.g. motor limits.
+    """
+
     USER_ACCESS = ["set_value", "set_range", "vertical", "indicator_width", "rounded_corners"]
     PLUGIN = True
     ICON_NAME = "horizontal_distribute"

bec_widgets/widgets/control/scan_control/scan_control.py

@@ -41,6 +41,10 @@ class ScanControlConfig(ConnectionConfig):
 
 
 class ScanControl(BECWidget, QWidget):
+    """
+    Widget to submit new scans to the queue.
+    """
+
     PLUGIN = True
     ICON_NAME = "tune"
     ARG_BOX_POSITION: int = 2

bec_widgets/widgets/plots/image/image.py

@@ -41,6 +41,10 @@ class ImageConfig(ConnectionConfig):
 
 
 class Image(PlotBase):
+    """
+    Image widget for displaying 2D data.
+    """
+
     PLUGIN = True
     RPC = True
     ICON_NAME = "image"

bec_widgets/widgets/plots/motor_map/motor_map.py

@@ -83,6 +83,10 @@ class MotorMapConfig(ConnectionConfig):
 
 
 class MotorMap(PlotBase):
+    """
+    Motor map widget for plotting motor positions in 2D including a trace of the last points.
+    """
+
     PLUGIN = True
     RPC = True
     ICON_NAME = "my_location"

bec_widgets/widgets/plots/multi_waveform/multi_waveform.py

@@ -45,6 +45,10 @@ class MultiWaveformConfig(ConnectionConfig):
 
 
 class MultiWaveform(PlotBase):
+    """
+    MultiWaveform widget for displaying multiple waveforms emitted by a single signal.
+    """
+
     PLUGIN = True
     RPC = True
     ICON_NAME = "ssid_chart"

bec_widgets/widgets/plots/waveform/waveform.py

@@ -38,6 +38,10 @@ class WaveformConfig(ConnectionConfig):
 
 
 class Waveform(PlotBase):
+    """
+    Widget for plotting waveforms.
+    """
+
     PLUGIN = True
     RPC = True
     ICON_NAME = "show_chart"

bec_widgets/widgets/progress/ring_progress_bar/ring_progress_bar.py

@@ -71,6 +71,10 @@ class RingProgressBarConfig(ConnectionConfig):
 
 
 class RingProgressBar(BECWidget, QWidget):
+    """
+    Show the progress of devices, scans or custom values in the form of ring progress bars.
+    """
+
     PLUGIN = True
     ICON_NAME = "track_changes"
     USER_ACCESS = [

bec_widgets/widgets/services/device_browser/device_browser.py

@@ -13,6 +13,10 @@ from bec_widgets.widgets.services.device_browser.device_item import DeviceItem
 
 
 class DeviceBrowser(BECWidget, QWidget):
+    """
+    DeviceBrowser is a widget that displays all available devices in the current BEC session.
+    """
+
     device_update: Signal = Signal()
     PLUGIN = True
     ICON_NAME = "lists"