Skip to content

Commit

Permalink
Resolve comments in CSharp.Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lewischeng-ms committed Jul 14, 2015
1 parent c37ae9a commit 3029731
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 13 deletions.
3 changes: 1 addition & 2 deletions src/Microsoft.Restier.Core/DomainBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,7 @@ protected DomainConfiguration DomainConfiguration
}

/// <summary>
/// Gets a value indicating whether this domain
/// has created its domain context.
/// Gets a value indicating whether this domain has created its domain context.
/// </summary>
protected bool HasDomainContext
{
Expand Down
3 changes: 1 addition & 2 deletions src/Microsoft.Restier.Core/IExpandableDomain.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ public interface IExpandableDomain : IDomain
DomainConfiguration Configuration { get; }

/// <summary>
/// Gets a value indicating whether this
/// expandable domain has been initialized.
/// Gets a value indicating whether this expandable domain has been initialized.
/// </summary>
bool IsInitialized { get; }

Expand Down
8 changes: 4 additions & 4 deletions src/Microsoft.Restier.Core/Submit/ChangeSetEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ internal ChangeSetEntry(ChangeSetEntryType type)
public DynamicChangeSetEntityState ChangeSetEntityState { get; set; }

/// <summary>
/// Indicates if this change set entry is in a changed state.
/// Indicates whether this change set entry is in a changed state.
/// </summary>
/// <returns>
/// If this change set entry is in a changed state.
/// Whether this change set entry is in a changed state.
/// </returns>
public bool HasChanged()
{
Expand Down Expand Up @@ -81,8 +81,8 @@ public enum DynamicChangeSetEntityState
PreEventing,

/// <summary>
/// The entity was modified within its own pre eventing interception method. This indicates that the entity
/// should be revalidated but its eventing interception point should not be invoked again.
/// The entity was modified within its own pre eventing interception method. This indicates that the entity
/// should be revalidated but its pre eventing interception point should not be invoked again.
/// </summary>
ChangedWithinOwnPreEventing,

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public static ChangeSetPreparer Instance
/// <summary>
/// Asynchronously prepare the <see cref="ChangeSet"/>.
/// </summary>
/// <param name="context">The context that contains the <see cref="ChangeSet"/>.</param>
/// <param name="context">The submit context class used for preparation.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The task object that represents this asynchronous operation.</returns>
public async Task PrepareAsync(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public static SubmitExecutor Instance
/// <summary>
/// Asynchronously executes the submission.
/// </summary>
/// <param name="context">The context that contains the <see cref="DbContext"/> and the <see cref="ChangeSet"/>.</param>
/// <param name="context">The submit context class used for preparation.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The task object that represents this asynchronous operation.</returns>
public async Task<SubmitResult> ExecuteSubmitAsync(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public ODataDomainChangeSetRequestItem(IEnumerable<HttpRequestMessage> requests,
/// </summary>
/// <param name="invoker">The invoker.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The task object that represents this asynchronous operation.</returns>
/// <returns>The task object that contains the batch response.</returns>
public override async Task<ODataBatchResponseItem> SendRequestAsync(HttpMessageInvoker invoker, CancellationToken cancellationToken)
{
Ensure.NotNull(invoker, "invoker");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ namespace Microsoft.Restier.WebApi
[EditorBrowsable(EditorBrowsableState.Never)]
public static class HttpConfigurationExtensions
{
/// TODO GitHubIssue#51 : Support model lazy loading
/// <summary>
/// Maps the domain routes to the given domain controller.
/// </summary>
Expand All @@ -33,7 +34,6 @@ public static class HttpConfigurationExtensions
/// <param name="domainFactory">The callback to create domain instances.</param>
/// <param name="batchHandler">The handler for batch requests.</param>
/// <returns>The task object containing the resulted <see cref="ODataRoute"/> instance.</returns>
/// TODO GitHubIssue#51 : Support model lazy loading
public static async Task<ODataRoute> MapODataDomainRoute<TController>(
this HttpConfiguration config, string routeName, string routePrefix,
Func<IDomain> domainFactory,
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Restier.WebApi/ODataDomainController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ protected ODataDomainController()
}

/// <summary>
/// Gets the <see cref="IDomain"/> interface of the domain of the <see cref="ODataDomainController"/>.
/// Gets the domain instance associated with the controller.
/// </summary>
public IDomain Domain
{
Expand Down

0 comments on commit 3029731

Please sign in to comment.