Skip to content

Commit

Permalink
[api-docs] Various fixes (#2487)
Browse files Browse the repository at this point in the history
This PR contains various fixes including filling in TBD placeholders,
fixed numerous copyright headers and converted a repetitive class to a
T4 template.
  • Loading branch information
sean-gilliam authored and Aaronontheweb committed Jan 31, 2017
1 parent af71e39 commit b0f114e
Show file tree
Hide file tree
Showing 53 changed files with 413 additions and 241 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -948,12 +948,10 @@ public class ShardHomeAllocated : IDomainEvent
/// <summary>
/// TBD
/// </summary>
/// <param name="shard">TBD</param>
public readonly ShardId Shard;
/// <summary>
/// TBD
/// </summary>
/// <param name="shard">TBD</param>
public readonly IActorRef Region;

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using System.Reflection;
//-----------------------------------------------------------------------
// <copyright file="AssemblyInfo.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using System.Reflection;
//-----------------------------------------------------------------------
// <copyright file="AssemblyInfo.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using System.Reflection;
//-----------------------------------------------------------------------
// <copyright file="AssemblyInfo.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using System;
//-----------------------------------------------------------------------
// <copyright file="ReplicatedDataSerializer.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using System;
using System.IO;
using Akka.Actor;
using Akka.Util;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using System;
//-----------------------------------------------------------------------
// <copyright file="ReplicatorMessageSerializer.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using System;
using System.Collections.Generic;
using System.IO;
using Akka.Actor;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//-----------------------------------------------------------------------
// <copyright file="AllPersistenceIdsPublisher.cs" company="Akka.NET Project">
// <copyright file="DeliveryBuffer.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Typesafe Inc. <http://www.typesafe.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using Akka.Configuration;
//-----------------------------------------------------------------------
// <copyright file="BatchingSqliteAllPersistenceIdSpec.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Typesafe Inc. <http://www.typesafe.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using Akka.Configuration;
using Akka.Persistence.Query.Sql;
using Akka.Persistence.Sql.TestKit;
using Akka.Util.Internal;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using Akka.Configuration;
//-----------------------------------------------------------------------
// <copyright file="BatchingSqliteEventsByPersistenceIdSpec.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Typesafe Inc. <http://www.typesafe.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using Akka.Configuration;
using Akka.Persistence.Query.Sql;
using Akka.Persistence.Sql.TestKit;
using Akka.Util.Internal;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using Akka.Configuration;
//-----------------------------------------------------------------------
// <copyright file="BatchingSqliteEventsByTagSpec.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Typesafe Inc. <http://www.typesafe.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using Akka.Configuration;
using Akka.Persistence.Query.Sql;
using Akka.Persistence.Sql.TestKit;
using Akka.Util.Internal;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using Akka.Configuration;
//-----------------------------------------------------------------------
// <copyright file="BatchingSqliteJournalSpec.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Typesafe Inc. <http://www.typesafe.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using Akka.Configuration;
using Akka.Persistence.TestKit.Journal;
using Akka.Util.Internal;
using Xunit.Abstractions;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//-----------------------------------------------------------------------
// <copyright file="SqliteEventsByTagSpec.cs" company="Akka.NET Project">
// <copyright file="SqliteAllPersistenceIdsSpec.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Typesafe Inc. <http://www.typesafe.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using System.Reflection;
//-----------------------------------------------------------------------
// <copyright file="AssemblyInfo.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using System.Reflection;
//-----------------------------------------------------------------------
// <copyright file="AssemblyInfo.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4639,7 +4639,7 @@ namespace Akka.Tools.MatchHandler
public sealed class PartialHandlerArgumentsCapture<T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> : Akka.Tools.MatchHandler.IPartialHandlerArgumentsCapture<T>
{
public PartialHandlerArgumentsCapture() { }
public bool Handle(T message) { }
public bool Handle(T value) { }
public void Initialize(System.Delegate handler, System.Collections.Generic.IReadOnlyList<object> arguments) { }
}
public sealed class PartialHandlerArgumentsCapture<T, T1> : Akka.Tools.MatchHandler.IPartialHandlerArgumentsCapture<T>
Expand Down
2 changes: 1 addition & 1 deletion src/core/Akka.Cluster.TestKit/MultiNodeClusterSpec.cs
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ public void StartClusterNode()
}

/// <summary>
/// Initialize the cluster of the specified member nodes (<see cref="roles"/>)
/// Initialize the cluster of the specified member nodes (<paramref name="roles"/>)
/// and wait until all joined and <see cref="MemberStatus.Up"/>.
///
/// First node will be started first and others will join the first.
Expand Down
2 changes: 1 addition & 1 deletion src/core/Akka.Persistence.Query/Interfaces.cs
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public interface IEventsByPersistenceIdQuery : IReadJournal
/// Query events for a specific <see cref="PersistentActor"/> identified by <paramref name="persistenceId"/>.
/// <para>
/// You can retrieve a subset of all events by specifying <paramref name="fromSequenceNr"/> and <paramref name="toSequenceNr"/>
/// or use <see cref="0L"/> and <see cref="long.MaxValue"/> respectively to retrieve all events.
/// or use <c>0L</c> and <see cref="long.MaxValue"/> respectively to retrieve all events.
/// </para>
/// The returned event stream should be ordered by sequence number.
/// <para>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//-----------------------------------------------------------------------
// <copyright file="PersistentActorFailureSpec.cs" company="Akka.NET Project">
// <copyright file="PersistentActorRecoveryTimeoutSpec.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
Expand Down
2 changes: 0 additions & 2 deletions src/core/Akka.Persistence/Eventsourced.Lifecycle.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ public partial class Eventsourced
/// <summary>
/// TBD
/// </summary>
/// <param name="envelope">TBD</param>
/// <returns>TBD</returns>
public static readonly Func<Envelope, bool> UnstashFilterPredicate =
envelope => !(envelope.Message is WriteMessageSuccess || envelope.Message is ReplayedMessage);

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//-----------------------------------------------------------------------
// <copyright file="RemoteRoundRobinSpec.cs" company="Akka.NET Project">
// <copyright file="RemoteReDeploymentSpec.cs" company="Akka.NET Project">
// Copyright (C) 2009-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
Expand Down
1 change: 1 addition & 0 deletions src/core/Akka.Remote/Endpoint.cs
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ internal sealed class ShutDownAssociation : EndpointException, IAssociationProbl
/// <summary>
/// TBD
/// </summary>
/// <param name="message">TBD</param>
/// <param name="localAddress">TBD</param>
/// <param name="remoteAddress">TBD</param>
/// <param name="cause">TBD</param>
Expand Down
3 changes: 0 additions & 3 deletions src/core/Akka.Remote/Transport/AkkaPduCodec.cs
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,6 @@ public Message(IInternalActorRef recipient, Address recipientAddress, Serialized
/// <summary>
/// TBD
/// </summary>
/// <param name="msg">TBD</param>
/// <param name="cause">TBD</param>
/// <returns>TBD</returns>
public IInternalActorRef Recipient { get; private set; }

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using System;
//-----------------------------------------------------------------------
// <copyright file="FusedGraphsBenchmark.cs" company="Akka.NET Project">
// Copyright (C) 2015-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using System;
using System.Linq;
using Akka.Actor;
using Akka.Streams.Dsl;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using Akka.IO;
//-----------------------------------------------------------------------
// <copyright file="JsonFramingBenchmark.cs" company="Akka.NET Project">
// Copyright (C) 2015-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using Akka.IO;
using Akka.Streams.Implementation;
using NBench;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//-----------------------------------------------------------------------
// <copyright file="AkkaSubscriberBlackboxVerification.cs" company="Akka.NET Project">
// <copyright file="AkkaSubscriberVerification.cs" company="Akka.NET Project">
// Copyright (C) 2015-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
Expand Down
2 changes: 1 addition & 1 deletion src/core/Akka.Streams.Tests.TCK/VirtualPublisherTest.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//-----------------------------------------------------------------------
// <copyright file="VirtualProcessorTest.cs" company="Akka.NET Project">
// <copyright file="VirtualPublisherTest.cs" company="Akka.NET Project">
// Copyright (C) 2015-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//-----------------------------------------------------------------------
// <copyright file="FlowSelectAsyncUnorderedSpec .cs" company="Akka.NET Project">
// <copyright file="FlowSelectAsyncUnorderedSpec.cs" company="Akka.NET Project">
// Copyright (C) 2015-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
Expand Down
9 changes: 8 additions & 1 deletion src/core/Akka.Streams/Dsl/Hub.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
using System;
//-----------------------------------------------------------------------
// <copyright file="Hub.cs" company="Akka.NET Project">
// Copyright (C) 2015-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
//-----------------------------------------------------------------------

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.Immutable;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//-----------------------------------------------------------------------
// <copyright file="UntypedPublisher.cs" company="Akka.NET Project">
// <copyright file="UntypedVirtualPublisher.cs" company="Akka.NET Project">
// Copyright (C) 2015-2016 Lightbend Inc. <http://www.lightbend.com>
// Copyright (C) 2013-2016 Akka.NET project <https://github.com/akkadotnet/akka.net>
// </copyright>
Expand Down
11 changes: 2 additions & 9 deletions src/core/Akka.Streams/Stage/AbstractStage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -199,18 +199,14 @@ public FreeDirective PushAndPull(TOut element)
/// <summary>
/// TBD
/// </summary>
/// <typeparam name="T2">TBD</typeparam>
/// <typeparam name="TMat2">TBD</typeparam>
/// <param name="flow">TBD</param>
/// <param name="element">TBD</param>
/// <returns>TBD</returns>
public IUpstreamDirective HoldUpstreamAndPush(object element) => HoldUpstreamAndPush((TOut) element);

/// <summary>
/// TBD
/// </summary>
/// <typeparam name="T2">TBD</typeparam>
/// <typeparam name="TMat2">TBD</typeparam>
/// <param name="flow">TBD</param>
/// <param name="element">TBD</param>
/// <returns>TBD</returns>
public IUpstreamDirective HoldUpstreamAndPush(TOut element)
{
Expand All @@ -221,9 +217,6 @@ public IUpstreamDirective HoldUpstreamAndPush(TOut element)
/// <summary>
/// TBD
/// </summary>
/// <typeparam name="T2">TBD</typeparam>
/// <typeparam name="TMat2">TBD</typeparam>
/// <param name="flow">TBD</param>
/// <returns>TBD</returns>
public IDownstreamDirective HoldDownstreamAndPull()
{
Expand Down
2 changes: 1 addition & 1 deletion src/core/Akka.TestKit/TestKitBase_ActorOf.cs
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ public ActorSelection ActorSelection(string actorPath)
/// <summary>
/// Creates an <see cref="ActorSelection(string)"/>
/// </summary>
/// <param name="anchorRef">The base actor that anchros the <see cref="actorPath"/>.</param>
/// <param name="anchorRef">The base actor that anchros the <paramref name="actorPath"/>.</param>
/// <param name="actorPath">The path of the actor(s) we want to select.</param>
/// <returns>An ActorSelection</returns>
public ActorSelection ActorSelection(IActorRef anchorRef, string actorPath)
Expand Down
2 changes: 1 addition & 1 deletion src/core/Akka.TestKit/TestProbe.cs
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ public void SendSystemMessage(ISystemMessage message)
/// Compares the underlying actor ref to the object.
/// </summary>
/// <param name="obj">The object to be compared to; ideally an <see cref="IActorRef"/>.</param>
/// <returns>An integer indicating if the actor sorts higher, lower, or equal to <see cref="obj"/>.</returns>
/// <returns>An integer indicating if the actor sorts higher, lower, or equal to <paramref name="obj"/>.</returns>
public int CompareTo(object obj)
{
return TestActor.CompareTo(obj);
Expand Down
4 changes: 2 additions & 2 deletions src/core/Akka/Actor/Scheduler/HashedWheelTimerScheduler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ private static Bucket[] CreateWheel(int ticksPerWheel, ILoggingAdapter log)
/// Normalize a wheel size to the nearest power of 2.
/// </summary>
/// <param name="ticksPerWheel">The original input per wheel.</param>
/// <returns><see cref="ticksPerWheel"/> normalized to the nearest power of 2.</returns>
/// <returns><paramref name="ticksPerWheel"/> normalized to the nearest power of 2.</returns>
private static int NormalizeTicksPerWheel(int ticksPerWheel)
{
var normalizedTicksPerWheel = 1;
Expand Down Expand Up @@ -576,7 +576,7 @@ public void ClearReschedule(HashSet<SchedulerRegistration> registrations)
private static readonly Action<object> ExecuteRunnableWithState = r => ((IRunnable)r).Run();

/// <summary>
/// Execute all <see cref="SchedulerRegistration"/>s that are due by or after <see cref="deadline"/>.
/// Execute all <see cref="SchedulerRegistration"/>s that are due by or after <paramref name="deadline"/>.
/// </summary>
/// <param name="deadline">The execution time.</param>
public void Execute(long deadline)
Expand Down
Loading

0 comments on commit b0f114e

Please sign in to comment.