Convert doxygen to rst for Toolbox, TrimeshReader

plugins/Toolbox/src/CloudSync/DiscrepanciesPresenter.py

@@ -8,9 +8,11 @@ from UM.Signal import Signal
 from .SubscribedPackagesModel import SubscribedPackagesModel
 
 
-## Shows a list of packages to be added or removed. The user can select which packages to (un)install. The user's
-#  choices are emitted on the `packageMutations` Signal.
 class DiscrepanciesPresenter(QObject):
+    """Shows a list of packages to be added or removed. The user can select which packages to (un)install. The user's
+    
+    choices are emitted on the `packageMutations` Signal.
+    """
 
     def __init__(self, app: QtApplication) -> None:
         super().__init__(app)

plugins/Toolbox/src/CloudSync/DownloadPresenter.py

@@ -16,9 +16,11 @@ from cura.UltimakerCloud.UltimakerCloudScope import UltimakerCloudScope
 from .SubscribedPackagesModel import SubscribedPackagesModel
 
 
-## Downloads a set of packages from the Ultimaker Cloud Marketplace
-# use download() exactly once: should not be used for multiple sets of downloads since this class contains state
 class DownloadPresenter:
+    """Downloads a set of packages from the Ultimaker Cloud Marketplace
+    
+    use download() exactly once: should not be used for multiple sets of downloads since this class contains state
+    """
 
     DISK_WRITE_BUFFER_SIZE = 256 * 1024  # 256 KB
 

plugins/Toolbox/src/CloudSync/LicensePresenter.py

@@ -43,10 +43,12 @@ class LicensePresenter(QObject):
 
         self._compatibility_dialog_path = "resources/qml/dialogs/ToolboxLicenseDialog.qml"
 
-    ## Show a license dialog for multiple packages where users can read a license and accept or decline them
-    # \param plugin_path: Root directory of the Toolbox plugin
-    # \param packages: Dict[package id, file path]
     def present(self, plugin_path: str, packages: Dict[str, Dict[str, str]]) -> None:
+        """Show a license dialog for multiple packages where users can read a license and accept or decline them
+        
+        :param plugin_path: Root directory of the Toolbox plugin
+        :param packages: Dict[package id, file path]
+        """
         if self._presented:
             Logger.error("{clazz} is single-use. Create a new {clazz} instead", clazz=self.__class__.__name__)
             return

plugins/Toolbox/src/CloudSync/RestartApplicationPresenter.py

@@ -3,9 +3,11 @@ from UM.Message import Message
 from cura.CuraApplication import CuraApplication
 
 
-## Presents a dialog telling the user that a restart is required to apply changes
-# Since we cannot restart Cura, the app is closed instead when the button is clicked
 class RestartApplicationPresenter:
+    """Presents a dialog telling the user that a restart is required to apply changes
+    
+    Since we cannot restart Cura, the app is closed instead when the button is clicked
+    """
     def __init__(self, app: CuraApplication) -> None:
         self._app = app
         self._i18n_catalog = i18nCatalog("cura")

plugins/Toolbox/src/CloudSync/SyncOrchestrator.py

@@ -16,20 +16,23 @@ from .RestartApplicationPresenter import RestartApplicationPresenter
 from .SubscribedPackagesModel import SubscribedPackagesModel
 
 
-## Orchestrates the synchronizing of packages from the user account to the installed packages
-# Example flow:
-# - CloudPackageChecker compares a list of packages the user `subscribed` to in their account
-#   If there are `discrepancies` between the account and locally installed packages, they are emitted
-# - DiscrepanciesPresenter shows a list of packages to be added or removed to the user. It emits the `packageMutations`
-#   the user selected to be performed
-# - The SyncOrchestrator uses PackageManager to remove local packages the users wants to see removed
-# - The DownloadPresenter shows a download progress dialog. It emits A tuple of succeeded and failed downloads
-# - The LicensePresenter extracts licenses from the downloaded packages and presents a license for each package to
-#   be installed. It emits the `licenseAnswers` signal for accept or declines
-# - The CloudApiClient removes the declined packages from the account
-# - The SyncOrchestrator uses PackageManager to install the downloaded packages and delete temp files.
-# - The RestartApplicationPresenter notifies the user that a restart is required for changes to take effect
 class SyncOrchestrator(Extension):
+    """Orchestrates the synchronizing of packages from the user account to the installed packages
+    
+    Example flow:
+
+    - CloudPackageChecker compares a list of packages the user `subscribed` to in their account
+      If there are `discrepancies` between the account and locally installed packages, they are emitted
+    - DiscrepanciesPresenter shows a list of packages to be added or removed to the user. It emits the `packageMutations`
+      the user selected to be performed
+    - The SyncOrchestrator uses PackageManager to remove local packages the users wants to see removed
+    - The DownloadPresenter shows a download progress dialog. It emits A tuple of succeeded and failed downloads
+    - The LicensePresenter extracts licenses from the downloaded packages and presents a license for each package to
+      be installed. It emits the `licenseAnswers` signal for accept or declines
+    - The CloudApiClient removes the declined packages from the account
+    - The SyncOrchestrator uses PackageManager to install the downloaded packages and delete temp files.
+    - The RestartApplicationPresenter notifies the user that a restart is required for changes to take effect
+    """
 
     def __init__(self, app: CuraApplication) -> None:
         super().__init__()
@@ -63,10 +66,12 @@ class SyncOrchestrator(Extension):
         self._download_presenter.done.connect(self._onDownloadFinished)
         self._download_presenter.download(mutations)
 
-    ## Called when a set of packages have finished downloading
-    # \param success_items: Dict[package_id, Dict[str, str]]
-    # \param error_items: List[package_id]
     def _onDownloadFinished(self, success_items: Dict[str, Dict[str, str]], error_items: List[str]) -> None:
+        """Called when a set of packages have finished downloading
+        
+        :param success_items:: Dict[package_id, Dict[str, str]]
+        :param error_items:: List[package_id]
+        """
         if error_items:
             message = i18n_catalog.i18nc("@info:generic", "{} plugins failed to download".format(len(error_items)))
             self._showErrorMessage(message)
@@ -96,7 +101,8 @@ class SyncOrchestrator(Extension):
         if has_changes:
             self._restart_presenter.present()
 
-    ## Logs an error and shows it to the user
     def _showErrorMessage(self, text: str):
+        """Logs an error and shows it to the user"""
+
         Logger.error(text)
         Message(text, lifetime=0).show()