diff --git a/src/Gui/DocumentPy.xml b/src/Gui/DocumentPy.xml
index 6a551f2807..6775d9a9a5 100644
--- a/src/Gui/DocumentPy.xml
+++ b/src/Gui/DocumentPy.xml
@@ -15,164 +15,171 @@
- Show the object
-show() -> None
-
+ show(objName) -> None\n
+Show an object.\n
+objName : str\n Name of the `Gui.ViewProvider` to show.
- Hide the object
-hide() -> None
-
+ hide(objName) -> None\n
+Hide an object.\n
+objName : str\n Name of the `Gui.ViewProvider` to hide.
- Set the position
-setPos(matrix) -> None
+ setPos(objName, matrix) -> None\n
+Set the position of an object.\n
+objName : str\n Name of the `Gui.ViewProvider`.\n
+matrix : Base.Matrix\n Transformation to apply on the object.
- Set the given object in edit mode.
-setEdit([String:Name|ViewProvider|DocumentObject]|,mod,subname=None) -> Bool
-
+ setEdit(obj, mod=0, subName) -> bool\n
+Set an object in edit mode.\n
+obj : str, App.DocumentObject, Gui.ViewPrivider\n Object to set in edit mode.
+mod : int\n Edit mode.
+subName : str\n Subelement name. Optional.
- Returns the current object in edit mode or None if there is no such object
-getInEdit() -> Object or None
-
+ getInEdit() -> Gui.ViewProviderDocumentObject or None\n
+Returns the current object in edit mode or None if there is no such object.
- Reset (end) the current editing.
-resetEdit() -> None
-
+ resetEdit() -> None\n
+End the current editing.
- Add an Inventor object
-addAnnotation(AnnoName,FileName,[ModName]) -> None
-
+ addAnnotation(annoName, fileName, modName) -> None\n
+Add an Inventor object from a file.\n
+annoName : str\n Annotation name.
+fileName : str\n File name.
+modName : str\n Display mode name. Optional.
- Update the view representations of all objects
-update() -> None
-
+ update() -> None\n
+Update the view representations of all objects.
- Return the object with the given name
-getObject(Name) -> Object or None
+ getObject(objName) -> object or None\n
+Return the object with the given name. If no one exists, return None.\n
+ObjName : str\n Object name.
- deprecated -- use ActiveObject
+ activeObject() -> object or None\n
+The active object of the document. Deprecated, use ActiveObject.
- deprecated -- use ActiveView
+ activeView() -> object or None\n
+The active view of the document. Deprecated, use ActiveView.
- Return a list if mdi views of a given type
-mdiViewsOfType(type) -> list of MDIView
-
+ mdiViewsOfType(type) -> list of MDIView\n
+Return a list of mdi views of a given type.\n
+type : str\n Type name.
- Send a message to all views of the document
-sendMsgToViews(msg) -> None
-
+ sendMsgToViews(msg) -> None\n
+Send a message to all views of the document.\n
+msg : str
- Merges this document with another project file
-mergeProject(filename) -> None
-
+ mergeProject(fileName) -> None\n
+Merges this document with another project file.\n
+fileName : str\n File name.
- Change TreeItem of a document object.
-toggleTreeItem(DocObject,[flag=0]) -> None
---
-flag can be 0:Toggle, 1:Collapse, 2:Expand
-
+ toggleTreeItem(obj, mod=0, subName) -> None\n
+Change TreeItem of a document object.\n
+obj : App.DocumentObject
+mod : int\n Item mode.
+ 0: Toggle, 1: Collapse, 2: Expand, 3: Expand path.
+subName : str\n Subelement name. Optional.
- scroll the tree view to the item of a view object
-scrollToTreeItem(ViewObject) -> None
-
+ scrollToTreeItem(obj) -> None\n
+Scroll the tree view to the item of a view object.\n
+obj : Gui.ViewProviderDocumentObject
- Add or remove view object from scene graph of all views depending on its canAddToSceneGraph()
-toggleInSceneGraph(ViewObject) -> None
-
+ toggleInSceneGraph(obj) -> None\n
+Add or remove view object from scene graph of all views depending\non its canAddToSceneGraph().\n
+obj : Gui.ViewProvider
- The active object of the document
+ The active object of the document.
- The active view of the document
+ The active view of the document.
- The editing transformation matrix
+ The editing transformation matrix.
- A tuple(obj,subname,subElement,editMode) of editing object reference, or None if no object is in edit
+ A tuple(obj,subname,subElement,editMode) of editing object reference, or None if no object is in edit.
- Current edit mode. Only meaningful when there is a current object in edit
+ Current edit mode. Only meaningful when there is a current object in edit.
- The related App document to this Gui document
+ The related App document to this Gui document.
- Indicate whether the document is undoing/redoing
+ Indicate whether the document is undoing/redoing.
- Returns True if the document is marked as modified, and False otherwise
+ Returns True if the document is marked as modified, and False otherwise.