Use Doxygen-style comments for documentation

According to our style. Not just single line comments without anything else.

Contributes to issue CURA-6159.
This commit is contained in:
Ghostkeeper 2019-01-30 12:52:58 +01:00
parent dbec607d36
commit 14300e745f
No known key found for this signature in database
GPG Key ID: 86BEF881AE2CF276

View File

@ -68,11 +68,14 @@ class GlobalStack(CuraContainerStack):
def getLoadingPriority(cls) -> int: def getLoadingPriority(cls) -> int:
return 2 return 2
# The configured connection types can be used to find out if the global stack is configured to be connected with ## The configured connection types can be used to find out if the global
# a printer, without having to know all the details as to how this is exactly done (and without actually setting # stack is configured to be connected with a printer, without having to
# the stack to be active). This data can then in turn also be used when the global stack is active; If we can't # know all the details as to how this is exactly done (and without
# get a network connection, but it is configured to have one, we can display a different icon to indicate the # actually setting the stack to be active).
# difference. #
# This data can then in turn also be used when the global stack is active;
# If we can't get a network connection, but it is configured to have one,
# we can display a different icon to indicate the difference.
@pyqtProperty("QVariantList", notify=configuredConnectionTypesChanged) @pyqtProperty("QVariantList", notify=configuredConnectionTypesChanged)
def configuredConnectionTypes(self): def configuredConnectionTypes(self):
# Requesting it from the metadata actually gets them as strings (as that's what you get from serializing). # Requesting it from the metadata actually gets them as strings (as that's what you get from serializing).
@ -80,7 +83,7 @@ class GlobalStack(CuraContainerStack):
connection_types = self.getMetaDataEntry("connection_type", "").split(",") connection_types = self.getMetaDataEntry("connection_type", "").split(",")
return [int(connection_type) for connection_type in connection_types if connection_type != ""] return [int(connection_type) for connection_type in connection_types if connection_type != ""]
# \sa configuredConnectionTypes ## \sa configuredConnectionTypes
def addConfiguredConnectionType(self, connection_type): def addConfiguredConnectionType(self, connection_type):
configured_connection_types = self.configuredConnectionTypes configured_connection_types = self.configuredConnectionTypes
if connection_type not in configured_connection_types: if connection_type not in configured_connection_types:
@ -88,7 +91,7 @@ class GlobalStack(CuraContainerStack):
configured_connection_types.append(str(connection_type)) configured_connection_types.append(str(connection_type))
self.setMetaDataEntry("connection_type", ",".join(configured_connection_types)) self.setMetaDataEntry("connection_type", ",".join(configured_connection_types))
# \sa configuredConnectionTypes ## \sa configuredConnectionTypes
def removeConfiguredConnectionType(self, connection_type): def removeConfiguredConnectionType(self, connection_type):
configured_connection_types = self.configuredConnectionTypes configured_connection_types = self.configuredConnectionTypes
if connection_type in self.configured_connection_types: if connection_type in self.configured_connection_types: