3D-printing/Cura
1
0
Fork 0
mirror of https://github.com/Ultimaker/Cura.git synced 2025-11-22 10:21:39 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Converted comments in dir Cura/cura/API to rst style

Browse source 
Converted doxygen style comments to reStructuredText style in the files found in Cura/cura/API directory recursively  using the script dox_2_rst.py (provided in the Uranium repo). Comments were manually checked and changed if needed.

Comments from the hidden attributes in the class CuraAPI (_acount, _backups, _interface) were moved to the public property getters, so they docstrings are exposed to the user.
This commit is contained in:
Jelle Spijker 2020-04-22 20:57:41 +02:00 • committed by Jelle Spijker
parent 6aedab78dc
commit 68318d20fd
No known key found for this signature in database
GPG key ID: 6662DC033BE6B99A
5 changed files with 101 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

22
cura/API/__init__.py
View file

@ -12,13 +12,14 @@ if TYPE_CHECKING:
from cura.CuraApplication import CuraApplication
## The official Cura API that plug-ins can use to interact with Cura.
#
# Python does not technically prevent talking to other classes as well, but
# this API provides a version-safe interface with proper deprecation warnings
# etc. Usage of any other methods than the ones provided in this API can cause
# plug-ins to be unstable.
class CuraAPI(QObject):
"""The official Cura API that plug-ins can use to interact with Cura.
Python does not technically prevent talking to other classes as well, but this API provides a version-safe
interface with proper deprecation warnings etc. Usage of any other methods than the ones provided in this API can
cause plug-ins to be unstable.
"""
# For now we use the same API version to be consistent.
__instance = None # type: "CuraAPI"
@ -39,13 +40,10 @@ class CuraAPI(QObject):
def __init__(self, application: Optional["CuraApplication"] = None) -> None:
super().__init__(parent = CuraAPI._application)
# Accounts API
self._account = Account(self._application)
# Backups API
self._backups = Backups(self._application)
# Interface API
self._interface = Interface(self._application)
def initialize(self) -> None:
@ -53,12 +51,18 @@ class CuraAPI(QObject):
@pyqtProperty(QObject, constant = True)
def account(self) -> "Account":
"""Accounts API"""
return self._account
@property
def backups(self) -> "Backups":
"""Backups API"""
return self._backups
@property
def interface(self) -> "Interface":
"""Interface API"""
return self._interface