diff -r 643989a1e2bd -r e440aaf179ce src/eric7/Documentation/Source/eric7.Project.ProjectBaseBrowser.html
--- a/src/eric7/Documentation/Source/eric7.Project.ProjectBaseBrowser.html Wed Dec 20 15:42:44 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.ProjectBaseBrowser.html Wed Dec 20 19:28:22 2023 +0100
@@ -289,9 +289,9 @@
</p>
<dl>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
<dd>
-key of the hook to check (string)
+key of the hook to check
</dd>
</dl>
<dl>
@@ -310,17 +310,17 @@
</p>
<dl>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QModelIndex)</dt>
<dd>
-parent index of inserted rows (QModelIndex)
+parent index of inserted rows
</dd>
-<dt><i>start</i></dt>
+<dt><i>start</i> (int)</dt>
<dd>
-start row number (integer)
+start row number
</dd>
-<dt><i>end</i></dt>
+<dt><i>end</i> (int)</dt>
<dd>
-end row number (integer)
+end row number
</dd>
</dl>
<a NAME="ProjectBaseBrowser._collapseAllDirs" ID="ProjectBaseBrowser._collapseAllDirs"></a>
@@ -346,9 +346,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-relative name of file item to be repopulated (string)
+relative name of file item to be repopulated
</dd>
</dl>
<a NAME="ProjectBaseBrowser._configure" ID="ProjectBaseBrowser._configure"></a>
@@ -374,9 +374,9 @@
</p>
<dl>
-<dt><i>coord</i></dt>
+<dt><i>coord</i> (QPoint)</dt>
<dd>
-the position of the mouse pointer (QPoint)
+the position of the mouse pointer
</dd>
</dl>
<a NAME="ProjectBaseBrowser._copyToClipboard" ID="ProjectBaseBrowser._copyToClipboard"></a>
@@ -476,9 +476,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-relative name of file item to be repopulated (string)
+relative name of file item to be repopulated
</dd>
</dl>
<a NAME="ProjectBaseBrowser._projectClosed" ID="ProjectBaseBrowser._projectClosed"></a>
@@ -525,12 +525,12 @@
</p>
<dl>
-<dt><i>local</i></dt>
+<dt><i>local</i> (boolean))</dt>
<dd>
flag indicating local (i.e. non VCS controlled)
- file/directory entries should be selected (boolean)
+ file/directory entries should be selected
</dd>
-<dt><i>filterList</i></dt>
+<dt><i>filterList</i> (Class)</dt>
<dd>
list of classes to check against
</dd>
@@ -544,9 +544,9 @@
</p>
<dl>
-<dt><i>index</i></dt>
+<dt><i>index</i> (QModelIndex)</dt>
<dd>
-index of item to be selected (QModelIndex)
+index of item to be selected
</dd>
</dl>
<a NAME="ProjectBaseBrowser._setItemRangeSelected" ID="ProjectBaseBrowser._setItemRangeSelected"></a>
@@ -558,17 +558,17 @@
</p>
<dl>
-<dt><i>startIndex</i></dt>
+<dt><i>startIndex</i> (QModelIndex)</dt>
<dd>
-start index of range of items to set (QModelIndex)
+start index of range of items to set
</dd>
-<dt><i>endIndex</i></dt>
+<dt><i>endIndex</i> (QModelIndex)</dt>
<dd>
-end index of range of items to set (QModelIndex)
+end index of range of items to set
</dd>
-<dt><i>selected</i></dt>
+<dt><i>selected</i> (bool)</dt>
<dd>
-flag giving the new selection status (boolean)
+flag giving the new selection status
</dd>
</dl>
<a NAME="ProjectBaseBrowser._setItemSelected" ID="ProjectBaseBrowser._setItemSelected"></a>
@@ -580,13 +580,13 @@
</p>
<dl>
-<dt><i>index</i></dt>
+<dt><i>index</i> (QModelIndex)</dt>
<dd>
-index of item to set (QModelIndex)
+index of item to set
</dd>
-<dt><i>selected</i></dt>
+<dt><i>selected</i> (bool)</dt>
<dd>
-flag giving the new selection status (boolean)
+flag giving the new selection status
</dd>
</dl>
<a NAME="ProjectBaseBrowser._showContextMenu" ID="ProjectBaseBrowser._showContextMenu"></a>
@@ -602,9 +602,9 @@
</p>
<dl>
-<dt><i>menu</i></dt>
+<dt><i>menu</i> (QMenu)</dt>
<dd>
-reference to the menu to be shown (QMenu)
+reference to the menu to be shown
</dd>
</dl>
<a NAME="ProjectBaseBrowser._showContextMenuBack" ID="ProjectBaseBrowser._showContextMenuBack"></a>
@@ -616,9 +616,9 @@
</p>
<dl>
-<dt><i>menu</i></dt>
+<dt><i>menu</i> (QMenu)</dt>
<dd>
-reference to the menu to be shown (QMenu)
+reference to the menu to be shown
</dd>
</dl>
<a NAME="ProjectBaseBrowser._showContextMenuDir" ID="ProjectBaseBrowser._showContextMenuDir"></a>
@@ -634,9 +634,9 @@
</p>
<dl>
-<dt><i>menu</i></dt>
+<dt><i>menu</i> (QMenu)</dt>
<dd>
-reference to the menu to be shown (QMenu)
+reference to the menu to be shown
</dd>
</dl>
<a NAME="ProjectBaseBrowser._showContextMenuDirMulti" ID="ProjectBaseBrowser._showContextMenuDirMulti"></a>
@@ -652,9 +652,9 @@
</p>
<dl>
-<dt><i>menu</i></dt>
+<dt><i>menu</i> (QMenu)</dt>
<dd>
-reference to the menu to be shown (QMenu)
+reference to the menu to be shown
</dd>
</dl>
<a NAME="ProjectBaseBrowser._showContextMenuMulti" ID="ProjectBaseBrowser._showContextMenuMulti"></a>
@@ -671,9 +671,9 @@
</p>
<dl>
-<dt><i>menu</i></dt>
+<dt><i>menu</i> (QMenu)</dt>
<dd>
-reference to the menu to be shown (QMenu)
+reference to the menu to be shown
</dd>
</dl>
<a NAME="ProjectBaseBrowser._showProjectInFileManager" ID="ProjectBaseBrowser._showProjectInFileManager"></a>
@@ -692,13 +692,13 @@
</p>
<dl>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
<dd>
-for the hook method (string)
+for the hook method
</dd>
-<dt><i>method</i></dt>
+<dt><i>method</i> (function)</dt>
<dd>
-reference to the hook method (method object)
+reference to the hook method
</dd>
</dl>
<a NAME="ProjectBaseBrowser.addHookMethodAndMenuEntry" ID="ProjectBaseBrowser.addHookMethodAndMenuEntry"></a>
@@ -710,17 +710,17 @@
</p>
<dl>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
<dd>
-for the hook method (string)
+for the hook method
</dd>
-<dt><i>method</i></dt>
+<dt><i>method</i> (function)</dt>
<dd>
-reference to the hook method (method object)
+reference to the hook method
</dd>
-<dt><i>menuEntry</i></dt>
+<dt><i>menuEntry</i> (str)</dt>
<dd>
-entry to be shown in the context menu (string)
+entry to be shown in the context menu
</dd>
</dl>
<a NAME="ProjectBaseBrowser.currentDirectory" ID="ProjectBaseBrowser.currentDirectory"></a>
@@ -762,6 +762,12 @@
reference to the current item
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+BrowserItem
+</dd>
+</dl>
<a NAME="ProjectBaseBrowser.expandItemsByName" ID="ProjectBaseBrowser.expandItemsByName"></a>
<h4>ProjectBaseBrowser.expandItemsByName</h4>
<b>expandItemsByName</b>(<i>names</i>)
@@ -771,9 +777,9 @@
</p>
<dl>
-<dt><i>names</i></dt>
+<dt><i>names</i> (list of str)</dt>
<dd>
-list of item names to be expanded (list of string)
+list of item names to be expanded
</dd>
</dl>
<a NAME="ProjectBaseBrowser.getExpandedItemNames" ID="ProjectBaseBrowser.getExpandedItemNames"></a>
@@ -786,7 +792,13 @@
<dl>
<dt>Return:</dt>
<dd>
-list of expanded items names (list of string)
+list of expanded items names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="ProjectBaseBrowser.removeHookMethod" ID="ProjectBaseBrowser.removeHookMethod"></a>
@@ -798,9 +810,9 @@
</p>
<dl>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
<dd>
-for the hook method (string)
+for the hook method
</dd>
</dl>
<a NAME="ProjectBaseBrowser.selectFile" ID="ProjectBaseBrowser.selectFile"></a>
@@ -812,9 +824,9 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename of file to be highlighted (string)
+filename of file to be highlighted
</dd>
</dl>
<a NAME="ProjectBaseBrowser.selectFileLine" ID="ProjectBaseBrowser.selectFileLine"></a>
@@ -826,13 +838,13 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename of file to be highlighted (string)
+filename of file to be highlighted
</dd>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
<dd>
-one based line number of the item (integer)
+one based line number of the item
</dd>
</dl>
<a NAME="ProjectBaseBrowser.selectLocalDirEntries" ID="ProjectBaseBrowser.selectLocalDirEntries"></a>
