eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html

branch
eric7
changeset 9123
aefb731a4b4e
parent 9117
c6afba2049cf
child 9141
7085ece52151
--- a/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html	Sat Jun 04 16:57:02 2022 +0200
+++ b/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html	Sat Jun 04 16:58:05 2022 +0200
@@ -30,9 +30,25 @@
 <table>
 
 <tr>
+<td><a href="#_addCycloneDXDependency">_addCycloneDXDependency</a></td>
+<td>Function to add a dependency to the given list of components.</td>
+</tr>
+<tr>
+<td><a href="#addCycloneDXDependencies">addCycloneDXDependencies</a></td>
+<td>Function to add dependency data to the list of created components.</td>
+</tr>
+<tr>
+<td><a href="#addCycloneDXVulnerabilities">addCycloneDXVulnerabilities</a></td>
+<td>Function to add vulnerability data to the list of created components.</td>
+</tr>
+<tr>
 <td><a href="#createCycloneDXFile">createCycloneDXFile</a></td>
 <td>Function to create a CyccloneDX SBOM file.</td>
 </tr>
+<tr>
+<td><a href="#findCyccloneDXComponent">findCyccloneDXComponent</a></td>
+<td>Function to find a component in a given list of components.</td>
+</tr>
 </table>
 <hr />
 <hr />
@@ -86,6 +102,67 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="_addCycloneDXDependency" ID="_addCycloneDXDependency"></a>
+<h2>_addCycloneDXDependency</h2>
+<b>_addCycloneDXDependency</b>(<i>dependency, components</i>)
+
+<p>
+    Function to add a dependency to the given list of components.
+</p>
+<dl>
+
+<dt><i>dependency</i> (dict)</dt>
+<dd>
+dependency to be added
+</dd>
+<dt><i>components</i> (list of Component)</dt>
+<dd>
+list of components
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="addCycloneDXDependencies" ID="addCycloneDXDependencies"></a>
+<h2>addCycloneDXDependencies</h2>
+<b>addCycloneDXDependencies</b>(<i>parser, venvName</i>)
+
+<p>
+    Function to add dependency data to the list of created components.
+</p>
+<dl>
+
+<dt><i>parser</i> (BaseParser)</dt>
+<dd>
+reference to the parser object containing the list of
+        components
+</dd>
+<dt><i>venvName</i> (str)</dt>
+<dd>
+name of the virtual environment
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="addCycloneDXVulnerabilities" ID="addCycloneDXVulnerabilities"></a>
+<h2>addCycloneDXVulnerabilities</h2>
+<b>addCycloneDXVulnerabilities</b>(<i>parser</i>)
+
+<p>
+    Function to add vulnerability data to the list of created components.
+</p>
+<dl>
+
+<dt><i>parser</i> (BaseParser)</dt>
+<dd>
+reference to the parser object containing the list of
+        components
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="createCycloneDXFile" ID="createCycloneDXFile"></a>
 <h2>createCycloneDXFile</h2>
 <b>createCycloneDXFile</b>(<i>venvName</i>)
@@ -109,4 +186,37 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
+<hr />
+<a NAME="findCyccloneDXComponent" ID="findCyccloneDXComponent"></a>
+<h2>findCyccloneDXComponent</h2>
+<b>findCyccloneDXComponent</b>(<i>components, name</i>)
+
+<p>
+    Function to find a component in a given list of components.
+</p>
+<dl>
+
+<dt><i>components</i> (list of Component)</dt>
+<dd>
+list of components to scan
+</dd>
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the component to search for
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the found component or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Component or None
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial