📝 Add docstrings to ystade/qdmi-sc-device

[coderabbitai]

Docstrings generation was requested by @ystade.

• ✨ New QDMI Device to represent SC Devices #1328 (comment)

The following files were modified:

• include/mqt-core/qdmi/sc/Device.hpp
• src/na/device/Device.cpp
• src/qdmi/Driver.cpp
• src/qdmi/sc/App.cpp
• src/qdmi/sc/Device.cpp
• src/qdmi/sc/DynDevice.cpp
• src/qdmi/sc/Generator.cpp
• test/na/device/test_app.cpp
• test/na/device/test_device.cpp
• test/na/device/test_generator.cpp
• test/qdmi/sc/test_app.cpp
• test/qdmi/sc/test_device.cpp
• test/qdmi/sc/test_generator.cpp
• test/qdmi/test_driver.cpp

These file types are not supported

• json/sc/device.json
• src/qdmi/CMakeLists.txt
• src/qdmi/sc/CMakeLists.txt
• test/qdmi/CMakeLists.txt
• test/qdmi/sc/CMakeLists.txt

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

[github-actions]

Cpp-Linter Report ⚠️

Some files did not pass the configured checks!

clang-tidy (v21.1.7) reports: 6 concern(s)

• src/qdmi/sc/Generator.cpp:17:1: warning: [misc-include-cleaner]

  included header algorithm is not used directly

     17 | #include <algorithm>
        | ^~~~~~~~~~~~~~~~~~~~
     18 | #include <cassert>

• src/qdmi/sc/Generator.cpp:20:1: warning: [misc-include-cleaner]

  included header cstddef is not used directly

     20 | #include <cstddef>
        | ^~~~~~~~~~~~~~~~~~
     21 | #include <cstdint>

• src/qdmi/sc/Generator.cpp:23:1: warning: [misc-include-cleaner]

  included header functional is not used directly

     23 | #include <functional>
        | ^~~~~~~~~~~~~~~~~~~~~
     24 | #include <istream>

• src/qdmi/sc/Generator.cpp:27:1: warning: [misc-include-cleaner]

  included header ranges is not used directly

     27 | #include <ranges>
        | ^~~~~~~~~~~~~~~~~
     28 | #include <spdlog/spdlog.h>

• src/qdmi/sc/Generator.cpp:32:1: warning: [misc-include-cleaner]

  included header tuple is not used directly

     32 | #include <tuple>
        | ^~~~~~~~~~~~~~~~
     33 | #include <utility>

• src/qdmi/sc/Generator.cpp:33:1: warning: [misc-include-cleaner]

  included header utility is not used directly

     33 | #include <utility>
        | ^~~~~~~~~~~~~~~~~~
     34 | #include <vector>

Have any feedback or feature suggestions? Share it here.