Regenerated the source code documentation. eric7

Tue, 18 Mar 2025 18:20:04 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Tue, 18 Mar 2025 18:20:04 +0100
branch
eric7
changeset 11175
ca7057547506
parent 11174
ab097070aedf
child 11176
1b0e4bf80f49

Regenerated the source code documentation.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Tue Mar 18 18:19:14 2025 +0100
+++ b/src/eric7/APIs/Python3/eric7.api	Tue Mar 18 18:20:04 2025 +0100
@@ -10281,13 +10281,12 @@
 eric7.SystemUtilities.FileSystemUtilities.compactPath?4(path, width, measure=len)
 eric7.SystemUtilities.FileSystemUtilities.deviceFileName?4(fileName)
 eric7.SystemUtilities.FileSystemUtilities.direntries?4(path, filesonly=False, pattern=None, followsymlinks=True, checkStop=None, ignore=None, recursive=True, dirsonly=False, )
-eric7.SystemUtilities.FileSystemUtilities.findVolume?4(volumeName, findAll=False)
+eric7.SystemUtilities.FileSystemUtilities.findVolume?4(volumeName, findAll=False, markerFile=None)
 eric7.SystemUtilities.FileSystemUtilities.fromNativeSeparators?4(path)
 eric7.SystemUtilities.FileSystemUtilities.getDirs?4(path, excludeDirs)
 eric7.SystemUtilities.FileSystemUtilities.getExecutablePath?4(file)
 eric7.SystemUtilities.FileSystemUtilities.getExecutablePaths?4(file)
 eric7.SystemUtilities.FileSystemUtilities.getUserMounts?4()
-eric7.SystemUtilities.FileSystemUtilities.getVolumeName?4(diskName)
 eric7.SystemUtilities.FileSystemUtilities.isDeviceFileName?4(fileName)
 eric7.SystemUtilities.FileSystemUtilities.isDrive?4(path)
 eric7.SystemUtilities.FileSystemUtilities.isExecutable?4(exe)
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Tue Mar 18 18:19:14 2025 +0100
+++ b/src/eric7/Documentation/Help/source.qhp	Tue Mar 18 18:20:04 2025 +0100
@@ -20979,7 +20979,6 @@
       <keyword name="getVcsSystemIndicator" id="getVcsSystemIndicator" ref="eric7.Plugins.PluginVcsSubversion.html#getVcsSystemIndicator" />
       <keyword name="getVersions" id="getVersions" ref="eric7.Testing.Interfaces.PytestRunner.html#getVersions" />
       <keyword name="getViewManager" id="getViewManager" ref="eric7.Preferences.__init__.html#getViewManager" />
-      <keyword name="getVolumeName" id="getVolumeName" ref="eric7.SystemUtilities.FileSystemUtilities.html#getVolumeName" />
       <keyword name="getWebBrowser" id="getWebBrowser" ref="eric7.Preferences.__init__.html#getWebBrowser" />
       <keyword name="getWebBrowserSupport" id="getWebBrowserSupport" ref="eric7.Globals.__init__.html#getWebBrowserSupport" />
       <keyword name="getWebEngineVersions" id="getWebEngineVersions" ref="eric7.WebBrowser.Tools.WebBrowserTools.html#getWebEngineVersions" />
--- a/src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html	Tue Mar 18 18:19:14 2025 +0100
+++ b/src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html	Tue Mar 18 18:20:04 2025 +0100
@@ -69,10 +69,6 @@
 <td>Function to determine all available user mounts.</td>
 </tr>
 <tr>
-<td><a href="#getVolumeName">getVolumeName</a></td>
-<td>Local function to determine the volume of a disk or device.</td>
-</tr>
-<tr>
 <td><a href="#isDeviceFileName">isDeviceFileName</a></td>
 <td>Function to check, if the given file name is a device file name.</td>
 </tr>
@@ -354,7 +350,7 @@
 <hr />
 <a NAME="findVolume" ID="findVolume"></a>
 <h2>findVolume</h2>
-<b>findVolume</b>(<i>volumeName, findAll=False</i>)
+<b>findVolume</b>(<i>volumeName, findAll=False, markerFile=None</i>)
 <p>
     Function to find the directory belonging to a given volume name.
 </p>
@@ -370,6 +366,10 @@
 flag indicating to get the directories for all volumes
         starting with the given name (defaults to False)
 </dd>
+<dt><i>markerFile</i> (str (optional))</dt>
+<dd>
+name of a file to check for its existence (defaults to None)
+</dd>
 </dl>
 <dl>
 <dt>Return:</dt>
@@ -536,24 +536,6 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
-<a NAME="getVolumeName" ID="getVolumeName"></a>
-<h2>getVolumeName</h2>
-<b>getVolumeName</b>(<i>diskName</i>)
-<p>
-            Local function to determine the volume of a disk or device.
-</p>
-<p>
-            Each disk or external device connected to windows has an
-            attribute called "volume name". This function returns the
-            volume name for the given disk/device.
-</p>
-<p>
-            Code from http://stackoverflow.com/a/12056414
-</p>
-
-<div align="right"><a href="#top">Up</a></div>
-<hr />
-<hr />
 <a NAME="isDeviceFileName" ID="isDeviceFileName"></a>
 <h2>isDeviceFileName</h2>
 <b>isDeviceFileName</b>(<i>fileName</i>)

eric ide

mercurial