Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/Microsoft.Sbom.Api/Config/ApiConfigurationBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ public static class ApiConfigurationBuilder
/// <param name="metadata"></param>
/// <param name="specifications"></param>
/// <param name="runtimeConfiguration"></param>
/// <param name="verbosity"></param>
/// <returns>A generate configuration.</returns>
public static InputConfiguration GetConfiguration(
string rootPath,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public interface ILicenseInformationFetcher
/// <summary>
/// Converts the response from the ClearlyDefined API to a dictionary of licenses.
/// </summary>
/// <param name="httpResponse"> The response from a ClearlyDefined API request.</param>
/// <param name="httpResponseContent">The response from a ClearlyDefined API request.</param>
/// <returns></returns>
public IDictionary<string, string> ConvertClearlyDefinedApiResponseToList(string httpResponseContent);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ public void RecordException(Exception exception)
/// <summary>
/// Record any exception that was encountered during API calls.
/// </summary>
/// <param name="exception">The exception that was encountered.</param>
/// <param name="apiException">The exception that was encountered.</param>
/// <exception cref="ArgumentNullException">If the exception is null.</exception>
public void RecordAPIException(Exception apiException)
{
Expand All @@ -221,7 +221,7 @@ public void RecordAPIException(Exception apiException)
/// <summary>
/// Record any exception that was encountered during the detection or parsing of individual package metadata files.
/// </summary>
/// <param name="exception">The exception that was encountered.</param>
/// <param name="metadataException">The exception that was encountered.</param>
/// <exception cref="ArgumentNullException">If the exception is null.</exception>
public void RecordMetadataException(Exception metadataException)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ public void RecordPackageId(string packageId, string dependOn)
/// <summary>
/// Record a externalDocumentReference Id that is included in this SBOM.
/// </summary>
/// <param name="fileId"></param>
public void RecordExternalDocumentReferenceIdAndRootElement(string externalDocumentReferenceId, string rootElement)
{
if (string.IsNullOrEmpty(externalDocumentReferenceId))
Expand Down Expand Up @@ -95,7 +94,6 @@ public GenerationData GetGenerationData()
/// <summary>
/// Record the SHA1 hash for the file.
/// </summary>
/// <param name="hash"></param>
public void RecordChecksumForFile(Checksum[] checksums)
{
if (checksums is null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ public void AddInvalidElements(ElementsResult elementsResult)
/// <summary>
/// Validate that information about the SBOM document is present.
/// </summary>
/// <param name="elementsList"></param>
/// <exception cref="ParserException"></exception>
private void ValidateSbomDocCreationForNTIAMin(List<SpdxDocument> spdxDocuments, List<CreationInfo> creationInfos, HashSet<InvalidElementInfo> invalidElements)
{
Expand Down Expand Up @@ -93,7 +92,6 @@ private void ValidateSbomDocCreationForNTIAMin(List<SpdxDocument> spdxDocuments,
/// <summary>
/// Validate that all files have declared and concluded licenses.
/// </summary>
/// <param name="elementsList"></param>
/// <exception cref="ParserException"></exception>
private void ValidateSbomFilesForNTIAMin(List<File> files, HashSet<InvalidElementInfo> invalidElements)
{
Expand All @@ -112,7 +110,6 @@ private void ValidateSbomFilesForNTIAMin(List<File> files, HashSet<InvalidElemen
/// <summary>
/// Validate that all packages have declared and concluded licenses.
/// </summary>
/// <param name="elementsList"></param>
/// <exception cref="ParserException"></exception>
private void ValidateSbomPackagesForNTIAMin(List<Package> packages, HashSet<InvalidElementInfo> invalidElements)
{
Expand Down
1 change: 0 additions & 1 deletion src/Microsoft.Sbom.Common/FileSystemUtilsProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ public static class FileSystemUtilsProvider
/// Checks the OS to provide the correct <see cref="IFileSystemUtils"/>.
/// This is important due to the different file systems of operating systems.
/// </summary>
/// <param name="context"></param>
/// <param name="logger">Logger to capture Exceptions</param>
/// <returns></returns>
public static IFileSystemUtils CreateInstance(ILogger logger)
Expand Down
1 change: 0 additions & 1 deletion src/Microsoft.Sbom.Extensions/IManifestConfigHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ public interface IManifestConfigHandler
/// If the SBOM format is supported by the current implementation, populates the manifestConfig
/// object and returns true, or else returns false.
/// </summary>
/// <param name="manifestConfig"></param>
/// <returns></returns>
public bool TryGetManifestConfig(out ISbomConfig sbomConfig);
}
1 change: 0 additions & 1 deletion src/Microsoft.Sbom.Extensions/IManifestGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ public interface IManifestGenerator
/// </summary>
/// <param name="internalMetadataProvider">The <see cref="IInternalMetadataProvider"/> object provides
/// internal metadata that was generated for this SBOM run.</param>
/// <param name="rootPackageId">Return the generated root package id.</param>
/// <returns></returns>
public GenerationResult GenerateRootPackage(IInternalMetadataProvider internalMetadataProvider);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ public interface IManifestToolJsonSerializer : IAsyncDisposable, IDisposable
/// This writes a json element to the underlying stream.
/// Do not dispose jsonDocument in this method.
/// </summary>
/// <param name="jsonDocument">The json document.</param>
public void Write(JsonElement jsonElement);

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ public interface ISbomPackageDetailsRecorder
/// <summary>
/// Record a externalDocumentReference Id that is included in this SBOM.
/// </summary>
/// <param name="fileId"></param>
public void RecordExternalDocumentReferenceIdAndRootElement(string externalDocumentReferenceId, string rootElement);

/// <summary>
Expand All @@ -43,7 +42,6 @@ public interface ISbomPackageDetailsRecorder
/// <summary>
/// Record the SHA1 hash for the file.
/// </summary>
/// <param name="hash"></param>
public void RecordChecksumForFile(Checksum[] checksums);

/// <summary>
Expand Down
3 changes: 0 additions & 3 deletions src/Microsoft.Sbom.Extensions/ISbomParser.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,13 @@ public interface ISbomParser
/// <summary>
/// Advance the parser to the next available state.
/// </summary>
/// <param name="stream"></param>
/// <returns></returns>
public ParserStateResult? Next();

/// <summary>
/// Returns a <see cref="SbomMetadata"/> object using the metadata defined in the
/// current SBOM.
/// </summary>
/// <param name="stream"></param>
/// <returns></returns>
public SpdxMetadata GetMetadata();

Expand All @@ -42,6 +40,5 @@ public interface ISbomParser
/// Set conformance for SPDX 3.0 parsers and above.
/// Returns the conformance set by the user, if it is valid.
/// </summary>
/// <param name="spdxVersion"></param>
public void EnforceConformance(ConformanceType conformance);
}
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,6 @@ private SpdxMetadata SetMetadata(ElementsResult result)
/// Handle deduplication of elements by checking SPDX ID
/// </summary>
/// <param name="spdxId"></param>
/// <param name="elementsList"></param>
/// <param name="elementsSpdxIdList"></param>
/// <returns></returns>
private bool IsUniqueElement(string spdxId, HashSet<string> elementsSpdxIdList)
Expand Down