Skip to content

Commit

Permalink
Fix minor documentation comment issues (#117)
Browse files Browse the repository at this point in the history
  • Loading branch information
gregkalapos authored and MikeGoldsmith committed Jan 28, 2019
1 parent 4b1c14c commit c534179
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/OpenTracing/ITracer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public interface ITracer
/// <param name="spanContext">The <see cref="ISpanContext"/> instance to inject into the <paramref name="carrier"/>.</param>
/// <param name="format">The <see cref="IFormat{TCarrier}"/> of the <paramref name="carrier"/>.</param>
/// <param name="carrier">
/// The carrier for the <see cref="ISpanContext"/> state. All <see cref="Inject"/> implementations must support
/// The carrier for the <see cref="ISpanContext"/> state. All <see cref="Inject{TCarrier}"/> implementations must support
/// <see cref="ITextMap"/> and <see cref="Stream"/>.
/// </param>
/// <seealso cref="IFormat{TCarrier}"/>
Expand All @@ -88,7 +88,7 @@ public interface ITracer
/// <typeparam name="TCarrier">The <paramref name="carrier"/> type, which also parametrizes the <paramref name="format"/>.</typeparam>
/// <param name="format">The <see cref="IFormat{TCarrier}"/> of the <paramref name="carrier"/>.</param>
/// <param name="carrier">
/// The carrier for the <see cref="ISpanContext"/> state. All <see cref="Extract"/> implementations must support
/// The carrier for the <see cref="ISpanContext"/> state. All <see cref="Extract{TCarrier}"/> implementations must support
/// <see cref="ITextMap"/> and <see cref="Stream"/>.
/// </param>
/// <returns>The <see cref="ISpanContext"/> instance holding context to create a span.</returns>
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTracing/Mock/MockSpan.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ private static string NextId()
private readonly List<Exception> _errors = new List<Exception>();

/// <summary>
/// The spanId of the span's first <see cref="References.ChildOf"/> reference, or the first reference of any type,
/// The spanId of the span's first <see cref="OpenTracing.References.ChildOf"/> reference, or the first reference of any type,
/// or null if no reference exists.
/// </summary>
/// <seealso cref="MockSpanContext.SpanId"/>
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTracing/Mock/MockTracer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public MockTracer(IScopeManager scopeManager, IPropagator propagator)

/// <summary>
/// Create a new <see cref="MockTracer"/> that passes through any calls
/// to <see cref="ITracer.Inject"/> and/or <see cref="ITracer.Extract"/>.
/// to <see cref="ITracer.Inject{TCarrier}"/> and/or <see cref="ITracer.Extract{TCarrier}"/>.
/// </summary>
public MockTracer(IPropagator propagator)
: this(new AsyncLocalScopeManager(), propagator)
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTracing/Mock/Propagators.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public static class Propagators
}

/// <summary>
/// Allows the developer to inject into the <see cref="MockTracer.Inject"/> and <see cref="MockTracer.Extract"/> calls.
/// Allows the developer to inject into the <see cref="MockTracer.Inject{TCarrier}"/> and <see cref="MockTracer.Extract{TCarrier}"/> calls.
/// </summary>
public interface IPropagator
{
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTracing/Propagation/TextMapExtractAdapter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
namespace OpenTracing.Propagation
{
/// <summary>
/// A <see cref="ITextMap"/> carrier for use with <see cref="ITracer.Extract"/> ONLY (it has no mutating methods). Note that the
/// A <see cref="ITextMap"/> carrier for use with <see cref="ITracer.Extract{TCarrier}"/> ONLY (it has no mutating methods). Note that the
/// <see cref="ITextMap"/> interface can be made to wrap around arbitrary data types
/// (not just <code>Dictionary&lt;string, string&gt;</code> as illustrated here).
/// </summary>
Expand Down

0 comments on commit c534179

Please sign in to comment.