--- a/src/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,28 +7,25 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.CycloneDXInterface.CycloneDXUtilities</h1>
-
<p>
Module implementing the interface to CycloneDX.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#CycloneDXEnvironmentParser">CycloneDXEnvironmentParser</a></td>
<td>Class implementing a parser to get package data for a named environment.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#_addCycloneDXDependency">_addCycloneDXDependency</a></td>
<td>Function to add a dependency to the given list of components.</td>
@@ -62,48 +59,48 @@
<td>Function to find a component in a given list of components.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="CycloneDXEnvironmentParser" ID="CycloneDXEnvironmentParser"></a>
<h2>CycloneDXEnvironmentParser</h2>
-
<p>
Class implementing a parser to get package data for a named environment.
</p>
+
<h3>Derived from</h3>
BaseParser
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#CycloneDXEnvironmentParser.__init__">CycloneDXEnvironmentParser</a></td>
<td>Constructor</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CycloneDXEnvironmentParser.__init__" ID="CycloneDXEnvironmentParser.__init__"></a>
<h4>CycloneDXEnvironmentParser (Constructor)</h4>
<b>CycloneDXEnvironmentParser</b>(<i>venvName</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -117,10 +114,10 @@
<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>
@@ -138,7 +135,6 @@
<a NAME="_amendMetaData" ID="_amendMetaData"></a>
<h2>_amendMetaData</h2>
<b>_amendMetaData</b>(<i>bomMetaData, metadataDict</i>)
-
<p>
Function to amend the SBOM meta data according the given data.
</p>
@@ -148,6 +144,7 @@
<li>add eric7 to the tools</li>
</ul>
</p>
+
<dl>
<dt><i>bomMetaData</i> (BomMetaData)</dt>
@@ -177,10 +174,10 @@
<a NAME="_prettifyJSON" ID="_prettifyJSON"></a>
<h2>_prettifyJSON</h2>
<b>_prettifyJSON</b>(<i>inputStr</i>)
-
<p>
Function to prettify the SBOM JSON output generated by CycloneDX.
</p>
+
<dl>
<dt><i>inputStr</i> (str)</dt>
@@ -206,13 +203,13 @@
<a NAME="_prettifyXML" ID="_prettifyXML"></a>
<h2>_prettifyXML</h2>
<b>_prettifyXML</b>(<i>inputStr</i>)
-
<p>
Function to prettify the SBOM XML output generated by CycloneDX.
</p>
<p>
Note: Prettifying an XML tree works only with Python 3.9 and above!
</p>
+
<dl>
<dt><i>inputStr</i> (str)</dt>
@@ -238,10 +235,10 @@
<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>
@@ -260,10 +257,10 @@
<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>
@@ -278,10 +275,10 @@
<a NAME="createCycloneDXFile" ID="createCycloneDXFile"></a>
<h2>createCycloneDXFile</h2>
<b>createCycloneDXFile</b>(<i>venvName</i>)
-
<p>
Function to create a CyccloneDX SBOM file.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -302,10 +299,10 @@
<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>
@@ -331,4 +328,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
