docs: added docstring to swid_parser.py (#3716)

* closes #3712
intel · Jan 17, 2024 · 470e206 · 470e206
1 parent 9e386cd
commit 470e206
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/cve_bin_tool/sbom_manager/swid_parser.py b/cve_bin_tool/sbom_manager/swid_parser.py
@@ -9,6 +9,10 @@
 
 
 class SWIDParser:
+    """
+    Class responsible for parsing SWID (Software Identification Tags) XML BOM (Bill of Materials) files.
+    """
+
     def __init__(self, validate: bool = True):
         self.validate = validate
 
@@ -35,6 +39,13 @@ def parse(self, sbom_file: str) -> list[list[str]]:
         return modules
 
     def extract(self, swid: str) -> list[str]:
+        """
+        Extracts the product name and version from a SWID entry.
+        args:
+            swid: SWID entry
+        returns:
+            list containing product name and version
+        """
         # Return parsed swid entry as [product, version] list item
         # Format of swid is "URI: <vendor>-<product>-<version>"
         item = swid[swid.find(":") + 1 :].split("-")