added developer comments to internals

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

src/builders/fromNodePackageJson.node.ts

@@ -37,6 +37,8 @@ export class ToolBuilder {
     return this.#extRefFactory
   }
 
+  // Current implementation does not return `undefined` yet, but it is an option for future implementation.
+  // To prevent breaking changes, it is declared to return `undefined`.
   makeTool (data: PackageJson): Models.Tool | undefined {
     const [name, vendor] = typeof data.name === 'string'
       ? splitNameGroup(data.name)

src/factories/packageUrl.ts

@@ -35,10 +35,6 @@ export class PackageUrlFactory {
   }
 
   makeFromComponent (component: Component, sort: boolean = false): PackageURL | undefined {
-    /**
-     * For the list/spec of the well-known keys, see
-     * {@link https://github.com/package-url/purl-spec/blob/master/PURL-SPECIFICATION.rst#known-qualifiers-keyvalue-pairs}
-     */
     const qualifiers: PackageURL['qualifiers'] = {}
     let subpath: PackageURL['subpath']
 

src/helpers/packageUrl.ts

@@ -19,8 +19,11 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 
 /**
  * Known PURL qualifier names.
- * To be used until {@link https://github.com/package-url/packageurl-js/pull/34} gets merged
+ * To be used until {@link https://github.com/package-url/packageurl-js/pull/34} gets merged and released,
  * and {@link https://github.com/package-url/packageurl-js/issues/35} gets sorted out.
+ *
+ * For the list/spec of the well-known keys,
+ * see {@link https://github.com/package-url/purl-spec/blob/master/PURL-SPECIFICATION.rst#known-qualifiers-keyvalue-pairs}
  */
 export const enum PackageUrlQualifierNames {
   DownloadURL = 'download_url',