Skip to content

Commit

Permalink
chore: Fix Doxygen warnings (#209)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig authored Oct 30, 2024
1 parent 0585bfa commit ec10eb2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
19 changes: 10 additions & 9 deletions Fauna/Core/StreamOptions.cs
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
namespace Fauna;

/// <summary>
/// Represents the options when subscribing to Fauna Streams.
/// Represents the options when subscribing to Fauna Event Streams.
/// </summary>
public class StreamOptions
{
/// <summary>
/// Initializes a new instance of the <see cref="StreamOptions"/> class with the specified token and cursor.
/// </summary>
/// <param name="token">The token returned from Fauna when the stream is created.</param>
/// <param name="token">The token for a Fauna event source.</param>
/// <param name="cursor">The cursor from the stream, must be used with the associated Token. Used to resume the stream.</param>
/// <seealso href="https://docs.fauna.com/fauna/current/reference/streaming/#restart-a-stream"/>
/// See <a href="https://docs.fauna.com/fauna/current/reference/cdc/#restart">Restart an Event Stream</a>.
public StreamOptions(string token, string cursor)
{
Token = token;
Expand All @@ -20,23 +20,24 @@ public StreamOptions(string token, string cursor)
/// <summary>
/// Initializes a new instance of the <see cref="StreamOptions"/> class with the specified token and start timestamp.
/// </summary>
/// <param name="token">The token returned from Fauna when the stream is created.</param>
/// <param name="token">The token for a Fauna event source.</param>
/// <param name="startTs">The start timestamp to use for the stream.</param>
public StreamOptions(string token, long startTs)
{
Token = token;
StartTs = startTs;
}

// <summary>Token returned from Fauna when the stream is created.</summary>
/// <see href="https://docs.fauna.com/fauna/current/reference/http/reference/stream/get/"/>
/// <summary>Token for a Fauna event source.</summary>
/// See the <a
/// href="https://docs.fauna.com/fauna/current/reference/cdc/#event-source">Create an event source</a>.
public string? Token { get; }

/// <summary>Cursor from the stream, must be used with the associated Token. Used to resume the stream.</summary>
/// <see href="https://docs.fauna.com/fauna/current/reference/streaming/#restart-a-stream"/>
/// See <a href="https://docs.fauna.com/fauna/current/reference/cdc/#restart-cursor">Restart from an event cursor</a>.
public string? Cursor { get; }

// <summary>Start timestamp from the stream, must be used with the associated Token. Used to resume the stream.</summary>
/// <see href="https://docs.fauna.com/fauna/current/reference/streaming/#restart-a-stream"/>
/// <summary>Start timestamp from the stream, must be used with the associated Token. Used to resume the stream.</summary>
/// See <a href="https://docs.fauna.com/fauna/current/reference/cdc/#restart-txn-ts">Restart from a transaction timestamp</a>.
public long? StartTs { get; }
}
2 changes: 1 addition & 1 deletion Fauna/Types/Module.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ namespace Fauna.Types;

/// <summary>
/// Represents a module, a singleton object grouping related functionalities.
/// Modules are serialized as @mod values in tagged formats, organizing and encapsulating specific functionalities.
/// Modules are serialized as \@mod values in tagged formats, organizing and encapsulating specific functionalities.
/// </summary>
public sealed class Module : IEquatable<Module>
{
Expand Down

0 comments on commit ec10eb2

Please sign in to comment.