Skip to content

Commit

Permalink
docs: add doc comments to ISession members
Browse files Browse the repository at this point in the history
  • Loading branch information
Ace4896 committed Apr 8, 2023
1 parent 4426c94 commit 6e51b20
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/DBus.Services.Secrets/Sessions/ISession.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,18 @@ public interface ISession
/// </summary>
ObjectPath SessionPath { get; }

/// <summary>
/// Formats the provided data into a <see cref="Secret"/>, which may involve encrypting it with the session's data.
/// </summary>
/// <param name="data">The data to format as a secret.</param>
/// <param name="contentType">The content type of the data.</param>
/// <returns>The formatted <see cref="Secret"/>.</returns>
Secret FormatSecret(byte[] data, string contentType);

/// <summary>
/// Decrypts the provided secret using the session's data.
/// </summary>
/// <param name="secret">The secret with the data to decrypt.</param>
/// <returns>The decrypted secret.</returns>
byte[] DecryptSecret(ref Secret secret);
}

0 comments on commit 6e51b20

Please sign in to comment.