API-Dokumentation
=================

Die automatisch generierte API-Dokumentation basiert auf den Docstrings im Python-Code.

Hauptmodule
-----------

.. automodule:: main
   :members:
   :undoc-members:
   :show-inheritance:

Device Management
-----------------

.. automodule:: src.device_manager
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: src.arduino
   :members:
   :undoc-members:
   :show-inheritance:

Data Controller
---------------

.. automodule:: src.data_controller
   :members:
   :undoc-members:
   :show-inheritance:

Helper Classes
--------------

.. automodule:: src.helper_classes
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: src.control
   :members:
   :undoc-members:
   :show-inheritance:

Debug Utilities
---------------

.. automodule:: src.debug_utils
   :members:
   :undoc-members:
   :show-inheritance:

Automatisch generierte Dokumentation
------------------------------------

MainWindow
~~~~~~~~~~

.. automodule:: src.main_window
   :members:
   :undoc-members:
   :show-inheritance:

DataController
~~~~~~~~~~~~~~

.. automodule:: src.data_controller
   :members:
   :undoc-members:
   :show-inheritance:

DeviceManager
~~~~~~~~~~~~~

.. automodule:: src.device_manager
   :members:
   :undoc-members:
   :show-inheritance:

Control
~~~~~~~

.. automodule:: src.control
   :members:
   :undoc-members:
   :show-inheritance:

Plot
~~~~

.. automodule:: src.plot
   :members:
   :undoc-members:
   :show-inheritance:

Helper Classes
~~~~~~~~~~~~~~

.. automodule:: src.helper_classes
   :members:
   :undoc-members:
   :show-inheritance:

Debug Utils
~~~~~~~~~~~

.. automodule:: src.debug_utils
   :members:
   :undoc-members:
   :show-inheritance:

Arduino
~~~~~~~

.. automodule:: src.arduino
   :members:
   :undoc-members:
   :show-inheritance:

Connection
~~~~~~~~~~

.. automodule:: src.connection
   :members:
   :undoc-members:
   :show-inheritance:

Verwendung
----------

Die API-Dokumentation wird automatisch aus den Docstrings im Code generiert. Stellen Sie sicher, dass Ihre Funktionen und Klassen ordnungsgemäß dokumentiert sind:

.. code-block:: python

    class MainWindow(QMainWindow):
        """Main window of the HRNGGUI application.

        It handles the user interface, the device connection and the
        processing of the recorded data.  The implementation is split
        into several functional sections:

        1. Initialization and setup
        2. Data processing and statistics
        3. Measurement management
        4. UI event handlers
        5. Device control
        6. Helper functions
        """

        def __init__(self, device_manager: DeviceManager, parent=None):
            """
            Initialisiert das Hauptfenster und alle Komponenten der Anwendung.

            Args:
                device_manager (DeviceManager): Der verbundene Geräte-Manager
                parent: Das übergeordnete Widget (optional)
            """
            # Implementation...

Docstring-Stile
---------------

Die Dokumentation unterstützt sowohl Google- als auch NumPy-Style Docstrings:

Google Style
~~~~~~~~~~~~

.. code-block:: python

    def function_with_types_in_docstring(param1, param2):
        """Example function with types documented in the docstring.

        Args:
            param1 (int): The first parameter.
            param2 (str): The second parameter.

        Returns:
            bool: The return value. True for success, False otherwise.
        """
        return True

NumPy Style
~~~~~~~~~~~

.. code-block:: python

    def function_with_numpy_docstring(param1, param2):
        """Example function with NumPy style docstring.

        Parameters
        ----------
        param1 : int
            The first parameter.
        param2 : str
            The second parameter.

        Returns
        -------
        bool
            The return value. True for success, False otherwise.
        """
        return True