Updated comments in Backup

Converted doxygen style comments to reStructuredText style in the files
 found in Cura/cura/Backup directory recursively  using the script
dox_2_rst.py (provided in the Uranium repo). Comments were manually
 checked and changed if needed.
This commit is contained in:
Jelle Spijker 2020-05-08 15:39:16 +02:00 committed by Jelle Spijker
parent 176919eee0
commit d69bf84424
No known key found for this signature in database
GPG key ID: 6662DC033BE6B99A
2 changed files with 31 additions and 18 deletions

View file

@ -24,6 +24,7 @@ class BackupsManager:
def createBackup(self) -> Tuple[Optional[bytes], Optional[Dict[str, str]]]:
"""
Get a back-up of the current configuration.
:return: A tuple containing a ZipFile (the actual back-up) and a dict containing some metadata (like version).
"""
@ -37,6 +38,7 @@ class BackupsManager:
def restoreBackup(self, zip_file: bytes, meta_data: Dict[str, str]) -> None:
"""
Restore a back-up from a given ZipFile.
:param zip_file: A bytes object containing the actual back-up.
:param meta_data: A dict containing some metadata that is needed to restore the back-up correctly.
"""