Change docstrings to numpydoc
This commit is contained in:
parent
91f9dfa560
commit
3a4751b32a
@ -62,52 +62,60 @@ class EditorTool(QtCore.QObject):
|
|||||||
"""
|
"""
|
||||||
Initialize toolWidget here.
|
Initialize toolWidget here.
|
||||||
|
|
||||||
:type editorSession: EditorSession
|
Parameters
|
||||||
|
----------
|
||||||
|
|
||||||
|
editorSession: EditorSession
|
||||||
"""
|
"""
|
||||||
super(EditorTool, self).__init__(*args, **kwargs)
|
super(EditorTool, self).__init__(*args, **kwargs)
|
||||||
self.editorSession = editorSession
|
self.editorSession = editorSession
|
||||||
|
|
||||||
def mousePress(self, event):
|
def mousePress(self, event):
|
||||||
"""
|
"""
|
||||||
:type event: QMouseEvent
|
Parameters
|
||||||
event has been augmented with these attributes:
|
----------
|
||||||
|
|
||||||
|
event: QMouseEvent
|
||||||
|
event has been augmented with these attributes:
|
||||||
point, ray, blockPosition, blockFace
|
point, ray, blockPosition, blockFace
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def mouseMove(self, event):
|
def mouseMove(self, event):
|
||||||
"""
|
"""
|
||||||
:type event: QMouseEvent
|
|
||||||
|
|
||||||
event has been augmented
|
Parameters
|
||||||
|
----------
|
||||||
|
|
||||||
|
event: QMouseEvent
|
||||||
|
event has been augmented
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def mouseDrag(self, event):
|
def mouseDrag(self, event):
|
||||||
"""
|
"""
|
||||||
:type event: QMouseEvent
|
Parameters
|
||||||
|
----------
|
||||||
|
|
||||||
event has been augmented
|
event: QMouseEvent
|
||||||
|
event has been augmented
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def mouseRelease(self, event):
|
def mouseRelease(self, event):
|
||||||
"""
|
"""
|
||||||
:type event: QMouseEvent
|
Parameters
|
||||||
|
----------
|
||||||
|
|
||||||
event has been augmented
|
event: QMouseEvent
|
||||||
|
event has been augmented
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def toolActive(self):
|
def toolActive(self):
|
||||||
"""
|
"""
|
||||||
Called when this tool is selected.
|
Called when this tool is selected.
|
||||||
:return:
|
|
||||||
:rtype:
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def toolInactive(self):
|
def toolInactive(self):
|
||||||
"""
|
"""
|
||||||
Called when a different tool is selected.
|
Called when a different tool is selected.
|
||||||
:return:
|
|
||||||
:rtype:
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
toolPicked = QtCore.Signal(object)
|
toolPicked = QtCore.Signal(object)
|
||||||
|
Reference in New Issue
Block a user