src/eric7/Documentation/Source/eric7.Project.ProjectSourcesBrowser.html

branch
eric7
changeset 9215
30d7f7fd2b4a
parent 9209
b99e7fd55fd3
child 9454
f3cf935c0c66
--- a/src/eric7/Documentation/Source/eric7.Project.ProjectSourcesBrowser.html	Mon Jul 11 16:42:50 2022 +0200
+++ b/src/eric7/Documentation/Source/eric7.Project.ProjectSourcesBrowser.html	Mon Jul 11 16:47:57 2022 +0200
@@ -120,6 +120,10 @@
 <td>Private slot to load a diagram from file.</td>
 </tr>
 <tr>
+<td><a href="#ProjectSourcesBrowser.__performFormatWithBlack">__performFormatWithBlack</a></td>
+<td>Private method to format the selected project sources using the 'Black' tool.</td>
+</tr>
+<tr>
 <td><a href="#ProjectSourcesBrowser.__showApplicationDiagram">__showApplicationDiagram</a></td>
 <td>Private method to handle the application diagram context menu action.</td>
 </tr>
@@ -156,6 +160,10 @@
 <td>Private slot called by the dirMultiMenu aboutToShow signal.</td>
 </tr>
 <tr>
+<td><a href="#ProjectSourcesBrowser.__showContextMenuFormatting">__showContextMenuFormatting</a></td>
+<td>Private slot called before the Code Formatting menu is shown.</td>
+</tr>
+<tr>
 <td><a href="#ProjectSourcesBrowser.__showContextMenuGraphics">__showContextMenuGraphics</a></td>
 <td>Private slot called before the checks menu is shown.</td>
 </tr>
@@ -311,6 +319,30 @@
 <p>
         Private slot to load a diagram from file.
 </p>
+<a NAME="ProjectSourcesBrowser.__performFormatWithBlack" ID="ProjectSourcesBrowser.__performFormatWithBlack"></a>
+<h4>ProjectSourcesBrowser.__performFormatWithBlack</h4>
+<b>__performFormatWithBlack</b>(<i>action</i>)
+
+<p>
+        Private method to format the selected project sources using the 'Black' tool.
+</p>
+<p>
+        Following actions are supported.
+        <ul>
+        <li>BlackFormattingAction.Format - the code reformatting is performed</li>
+        <li>BlackFormattingAction.Check - a check is performed, if code formatting
+            is necessary</li>
+        <li>BlackFormattingAction.Diff - a unified diff of potential code formatting
+            changes is generated</li>
+        </ul>
+</p>
+<dl>
+
+<dt><i>action</i> (BlackFormattingAction)</dt>
+<dd>
+formatting operation to be performed
+</dd>
+</dl>
 <a NAME="ProjectSourcesBrowser.__showApplicationDiagram" ID="ProjectSourcesBrowser.__showApplicationDiagram"></a>
 <h4>ProjectSourcesBrowser.__showApplicationDiagram</h4>
 <b>__showApplicationDiagram</b>(<i></i>)
@@ -374,6 +406,13 @@
 <p>
         Private slot called by the dirMultiMenu aboutToShow signal.
 </p>
+<a NAME="ProjectSourcesBrowser.__showContextMenuFormatting" ID="ProjectSourcesBrowser.__showContextMenuFormatting"></a>
+<h4>ProjectSourcesBrowser.__showContextMenuFormatting</h4>
+<b>__showContextMenuFormatting</b>(<i></i>)
+
+<p>
+        Private slot called before the Code Formatting menu is shown.
+</p>
 <a NAME="ProjectSourcesBrowser.__showContextMenuGraphics" ID="ProjectSourcesBrowser.__showContextMenuGraphics"></a>
 <h4>ProjectSourcesBrowser.__showContextMenuGraphics</h4>
 <b>__showContextMenuGraphics</b>(<i></i>)

eric ide

mercurial