Skip to content

Commit

Permalink
Add missing XML documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jen20 committed Sep 17, 2014
1 parent 8f38924 commit 793a04d
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/EventStore.ClientAPI.Embedded/EmbeddedVNodeBuilder.cs
Expand Up @@ -18,6 +18,10 @@

namespace EventStore.ClientAPI.Embedded
{
/// <summary>
/// Allows a client to build a <see cref="ClusterVNode" /> for use with the Embedded client API by specifying
/// high level options rather than using the constructor of <see cref="ClusterVNode"/> directly.
/// </summary>
public class EmbeddedVNodeBuilder
{
// ReSharper disable FieldCanBeMadeReadOnly.Local - as more options are added
Expand Down Expand Up @@ -565,6 +569,11 @@ private void SetUpProjectionsIfNeeded()
_subsystems.Add(new ProjectionsSubsystem(_projectionsThreads, internalProjectionType));
}

/// <summary>
/// Converts an <see cref="EmbeddedVNodeBuilder"/> to a <see cref="ClusterVNode"/>.
/// </summary>
/// <param name="builder"></param>
/// <returns></returns>
public static implicit operator ClusterVNode(EmbeddedVNodeBuilder builder)
{
builder.EnsureHttpPrefixes();
Expand Down
12 changes: 12 additions & 0 deletions src/EventStore.ClientAPI.Embedded/ProjectionsMode.cs
@@ -1,9 +1,21 @@
namespace EventStore.ClientAPI.Embedded
{
/// <summary>
/// Enumerates possible modes for running projections
/// </summary>
public enum ProjectionsMode
{
/// <summary>
/// Run no projections
/// </summary>
None,
/// <summary>
/// Run only system projections
/// </summary>
System,
/// <summary>
/// Run user and system proejctions
/// </summary>
All
}
}

0 comments on commit 793a04d

Please sign in to comment.