3D-printing/Cura
1
0
Fork 0
mirror of https://github.com/Ultimaker/Cura.git synced 2025-07-07 23:17:32 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Merge pull request #7551 from Ultimaker/doxygen_to_restructuredtext_comments

Browse source 
Converted doxygen style comments to reStructuredText style
This commit is contained in:
Nino van Hooff 2020-05-29 16:46:25 +02:00 • committed by GitHub
commit 98587a9008
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
224 changed files with 5521 additions and 3874 deletions
Download patch file Download diff file Expand all files Collapse all files

7
plugins/VersionUpgrade/VersionUpgrade35to40/VersionUpgrade35to40.py
View file

@ -34,8 +34,9 @@ class VersionUpgrade35to40(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades Preferences to have the new version number.
def upgradePreferences(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades Preferences to have the new version number."""
parser = configparser.ConfigParser(interpolation=None)
parser.read_string(serialized)
@ -48,9 +49,9 @@ class VersionUpgrade35to40(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades instance containers to have the new version
# number.
def upgradeInstanceContainer(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades instance containers to have the new version number."""
parser = configparser.ConfigParser(interpolation=None)
parser.read_string(serialized)

16
plugins/VersionUpgrade/VersionUpgrade40to41/VersionUpgrade40to41.py
View file

@ -20,12 +20,14 @@ _renamed_quality_profiles = {
} # type: Dict[str, str]
## Upgrades configurations from the state they were in at version 4.0 to the
# state they should be in at version 4.1.
class VersionUpgrade40to41(VersionUpgrade):
## Upgrades instance containers to have the new version
# number.
"""Upgrades configurations from the state they were in at version 4.0 to the
state they should be in at version 4.1.
"""
def upgradeInstanceContainer(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades instance containers to have the new version number."""
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)
@ -46,8 +48,9 @@ class VersionUpgrade40to41(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades Preferences to have the new version number.
def upgradePreferences(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades Preferences to have the new version number."""
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)
@ -66,8 +69,9 @@ class VersionUpgrade40to41(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades stacks to have the new version number.
def upgradeStack(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades stacks to have the new version number."""
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)

26
plugins/VersionUpgrade/VersionUpgrade41to42/VersionUpgrade41to42.py
View file

@ -214,14 +214,17 @@ _creality_limited_quality_type = {
}
## Upgrades configurations from the state they were in at version 4.1 to the
# state they should be in at version 4.2.
class VersionUpgrade41to42(VersionUpgrade):
## Upgrades instance containers to have the new version
# number.
#
# This renames the renamed settings in the containers.
"""Upgrades configurations from the state they were in at version 4.1 to the
state they should be in at version 4.2.
"""
def upgradeInstanceContainer(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades instance containers to have the new version number.
This renames the renamed settings in the containers.
"""
parser = configparser.ConfigParser(interpolation = None, comment_prefixes = ())
parser.read_string(serialized)
@ -257,10 +260,12 @@ class VersionUpgrade41to42(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades Preferences to have the new version number.
#
# This renames the renamed settings in the list of visible settings.
def upgradePreferences(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades Preferences to have the new version number.
This renames the renamed settings in the list of visible settings.
"""
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)
@ -284,8 +289,9 @@ class VersionUpgrade41to42(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades stacks to have the new version number.
def upgradeStack(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades stacks to have the new version number."""
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)

19
plugins/VersionUpgrade/VersionUpgrade42to43/VersionUpgrade42to43.py
View file

@ -57,9 +57,11 @@ _renamed_settings = {
} # type: Dict[str, str]
## Upgrades configurations from the state they were in at version 4.2 to the
# state they should be in at version 4.3.
class VersionUpgrade42to43(VersionUpgrade):
"""Upgrades configurations from the state they were in at version 4.2 to the
state they should be in at version 4.3.
"""
def upgradePreferences(self, serialized: str, filename: str):
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)
@ -77,16 +79,16 @@ class VersionUpgrade42to43(VersionUpgrade):
parser["general"]["visible_settings"] = ";".join(all_setting_keys)
parser["metadata"]["setting_version"] = "9"
result = io.StringIO()
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades instance containers to have the new version
# number.
#
# This renames the renamed settings in the containers.
def upgradeInstanceContainer(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades instance containers to have the new version number.
This renames the renamed settings in the containers.
"""
parser = configparser.ConfigParser(interpolation = None, comment_prefixes = ())
parser.read_string(serialized)
@ -111,8 +113,9 @@ class VersionUpgrade42to43(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades stacks to have the new version number.
def upgradeStack(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades stacks to have the new version number."""
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)

19
plugins/VersionUpgrade/VersionUpgrade43to44/VersionUpgrade43to44.py
View file

@ -27,10 +27,12 @@ _renamed_container_id_map = {
class VersionUpgrade43to44(VersionUpgrade):
## Upgrades Preferences to have the new version number.
#
# This renames the renamed settings in the list of visible settings.
def upgradePreferences(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades Preferences to have the new version number.
This renames the renamed settings in the list of visible settings.
"""
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)
@ -41,11 +43,11 @@ class VersionUpgrade43to44(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades instance containers to have the new version
# number.
#
# This renames the renamed settings in the containers.
def upgradeInstanceContainer(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades instance containers to have the new version number.
This renames the renamed settings in the containers.
"""
parser = configparser.ConfigParser(interpolation = None, comment_prefixes = ())
parser.read_string(serialized)
@ -72,8 +74,9 @@ class VersionUpgrade43to44(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades stacks to have the new version number.
def upgradeStack(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades stacks to have the new version number."""
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)

19
plugins/VersionUpgrade/VersionUpgrade44to45/VersionUpgrade44to45.py
View file

@ -122,10 +122,12 @@ class VersionUpgrade44to45(VersionUpgrade):
except OSError: # Is a directory, file not found, or insufficient rights.
continue
## Upgrades Preferences to have the new version number.
#
# This renames the renamed settings in the list of visible settings.
def upgradePreferences(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades Preferences to have the new version number.
This renames the renamed settings in the list of visible settings.
"""
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)
@ -136,11 +138,11 @@ class VersionUpgrade44to45(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades instance containers to have the new version
# number.
#
# This renames the renamed settings in the containers.
def upgradeInstanceContainer(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades instance containers to have the new version number.
This renames the renamed settings in the containers.
"""
parser = configparser.ConfigParser(interpolation = None, comment_prefixes = ())
parser.read_string(serialized)
@ -166,8 +168,9 @@ class VersionUpgrade44to45(VersionUpgrade):
parser.write(result)
return [filename], [result.getvalue()]
## Upgrades stacks to have the new version number.
def upgradeStack(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
"""Upgrades stacks to have the new version number."""
parser = configparser.ConfigParser(interpolation = None)
parser.read_string(serialized)