Skip to content

Commit

Permalink
Fixed documentation compiler warnings and some documentation inaccura…
Browse files Browse the repository at this point in the history
…cies.
  • Loading branch information
NightOwl888 committed Aug 21, 2014
1 parent 392540c commit bca8e5a
Show file tree
Hide file tree
Showing 27 changed files with 60 additions and 62 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,8 @@ ICultureContextFactory cultureContextFactory
/// <summary>
/// Gets the dynamic nodes for node.
/// </summary>
/// <param name="siteMap">The site map.</param>
/// <param name="node">The node.</param>
/// <param name="parentKey">The key of the parent node.</param>
/// <param name="node">The SiteMap node.</param>
/// <param name="defaultParentKey">The key of the parent node.</param>
public virtual IEnumerable<ISiteMapNodeToParentRelation> BuildDynamicNodes(ISiteMapNode node, string defaultParentKey)
{
var result = new List<ISiteMapNodeToParentRelation>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public interface ISiteMapBuilderSet
/// <summary>
/// Determines whether the provider instance matches the name
/// </summary>
/// <param name="providerName">The name of the builder set.</param>
/// <param name="builderSetName">The name of the builder set.</param>
/// <returns>
/// True if the builder set name matches.
/// </returns>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ public interface ISiteMapNodeCreator
/// </summary>
/// <param name="key">The key for the node. This cannot be changed.</param>
/// <param name="parentKey">The key of the intended parent node.</param>
/// <param name="node">The node to map to the parentKey.</param>
/// <param name="sourceName">A string description of the provider. This value is shown in exception messages related to the node configuration.</param>
/// <param name="implicitResourceKey">The implicit resource key for localization of the node's properties.</param>
/// <returns>An <see cref="T:MvcSiteMapProvider.Builder.ISiteMapNodeToParentRelation"/> instance.</returns>
Expand All @@ -25,7 +24,6 @@ public interface ISiteMapNodeCreator
/// </summary>
/// <param name="key">The key for the node. This cannot be changed.</param>
/// <param name="parentKey">The key of the intended parent node.</param>
/// <param name="node">The node to map to the parentKey.</param>
/// <param name="sourceName">A string description of the provider. This value is shown in exception messages related to the node configuration.</param>
/// <param name="implicitResourceKey">The implicit resource key for localization of the node's properties.</param>
/// <returns>An <see cref="T:MvcSiteMapProvider.Builder.ISiteMapNodeToParentRelation"/> instance.</returns>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ public interface ISiteMapNodeHelper
/// </summary>
/// <param name="key">The key for the node. This cannot be changed.</param>
/// <param name="parentKey">The key of the intended parent node.</param>
/// <param name="node">The node to map to the parentKey.</param>
/// <param name="sourceName">A string description of the provider. This value is shown in exception messages related to the node configuration.</param>
/// <returns>An <see cref="T:MvcSiteMapProvider.Builder.ISiteMapNodeToParentRelation"/> instance.</returns>
ISiteMapNodeToParentRelation CreateNode(string key, string parentKey, string sourceName);
Expand All @@ -41,7 +40,6 @@ public interface ISiteMapNodeHelper
/// </summary>
/// <param name="key">The key for the node. This cannot be changed.</param>
/// <param name="parentKey">The key of the intended parent node.</param>
/// <param name="node">The node to map to the parentKey.</param>
/// <param name="sourceName">A string description of the provider. This value is shown in exception messages related to the node configuration.</param>
/// <param name="implicitResourceKey">The implicit resource key for localization of the node's properties.</param>
/// <returns>An <see cref="T:MvcSiteMapProvider.Builder.ISiteMapNodeToParentRelation"/> instance.</returns>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
namespace MvcSiteMapProvider.Caching
{
/// <summary>
/// A cache provider that uses the <see cref="System.Web.HttpContext.Current.Cache"/> instance to
/// A cache provider that uses the <see cref="T:System.Web.HttpContext.Current.Cache"/> instance to
/// cache items that are added.
/// </summary>
/// <typeparam name="T">The type of item that will be stored in the cache.</typeparam>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace MvcSiteMapProvider.Collections
{
/// <summary>
/// An abstract factory that can be used to create new instances of <see cref="T:System.Collections.Generic.Dictionary<TKey, TValue>"/>
/// An abstract factory that can be used to create new instances of <see cref="T:System.Collections.Generic.Dictionary{TKey, TValue}"/>
/// at runtime.
/// </summary>
public class GenericDictionaryFactory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace MvcSiteMapProvider.Collections
{
/// <summary>
/// Contract for an abstract factory that creates new instances of <see cref="T:MvcSiteMapProvider.Collections.IDictionary<TKey, TValue>"/>
/// Contract for an abstract factory that creates new instances of <see cref="T:System.Collections.Generic.IDictionary{TKey, TValue}"/>
/// at runtime.
/// </summary>
public interface IGenericDictionaryFactory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ protected override string GetCacheKey()
/// <summary>
/// Adds a new element to the dictionary with the specified key and value. If the key exists, the value will be overwritten.
/// </summary>
/// <param name="item">The KeyValuePair object that contains the key and value to add.</param>
/// <param name="key">The key of the new item to add.</param>
/// <param name="value">The value of the new item to add.</param>
public override void Add(string key, object value)
{
this.Add(key, value, true);
Expand Down Expand Up @@ -111,18 +112,18 @@ public void Add(string key, object value, bool throwIfReservedKey)
}

/// <summary>
/// Adds the elements from a <see cref="System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// Adds the elements from a <see cref="T:System.Collections.Generic.Dictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// </summary>
/// <param name="items">The <see cref="System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="items">The <see cref="T:System.Collections.Generic.Dictionary{string, object}"/> of items to add.</param>
public override void AddRange(IDictionary<string, object> items)
{
this.AddRange(items, true);
}

/// <summary>
/// Adds the elements from a <see cref="System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// Adds the elements from a <see cref="T:System.Collections.Generic.Dictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// </summary>
/// <param name="items">The <see cref="System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="items">The <see cref="T:System.Collections.Generic.Dictionary{string, object}"/> of items to add.</param>
/// <param name="throwIfReservedKey"><c>true</c> to throw an exception if one of the keys being added is a reserved key name; otherwise, <c>false</c>.</param>
public void AddRange(IDictionary<string, object> items, bool throwIfReservedKey)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ public interface IAttributeDictionary
void Add(KeyValuePair<string, object> item, bool throwIfReservedKey);

/// <summary>
/// Adds the elements from a <see cref="System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// Adds the elements from a <see cref="T:System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// </summary>
/// <param name="items">The <see cref="System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="items">The <see cref="T:System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
void AddRange(IDictionary<string, object> items);

/// <summary>
/// Adds the elements from a <see cref="System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// Adds the elements from a <see cref="T:System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// </summary>
/// <param name="items">The <see cref="System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="items">The <see cref="T:System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="throwIfReservedKey"><c>true</c> to throw an exception if one of the keys being added is a reserved key name; otherwise, <c>false</c>.</param>
void AddRange(IDictionary<string, object> items, bool throwIfReservedKey);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ public interface IMetaRobotsValueCollection
void AddRange(string stringToSplit, char[] separator);

/// <summary>
/// Adds each element of a <see cref="System.Collections.Generic.IEnumerable{string}"/> to the collection as a new meta robots value. Duplicates will be ignored.
/// Adds each element of a <see cref="T:System.Collections.Generic.IEnumerable{string}"/> to the collection as a new meta robots value. Duplicates will be ignored.
/// </summary>
/// <param name="collection">The <see cref="System.Collections.Generic.IEnumerable{string}"/> containing the values to add, or <b>null</b>.</param>
/// <param name="collection">The <see cref="T:System.Collections.Generic.IEnumerable{string}"/> containing the values to add, or <b>null</b>.</param>
void AddRange(IEnumerable<string> collection);

string GetMetaRobotsContentString();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ public interface IPreservedRouteParameterCollection
void AddRange(string stringToSplit, char[] separator);

/// <summary>
/// Adds each element of a <see cref="System.Collections.Generic.IEnumerable{string}"/> to the collection.
/// Adds each element of a <see cref="T:System.Collections.Generic.IEnumerable{string}"/> to the collection.
/// </summary>
/// <param name="collection">The <see cref="System.Collections.Generic.IEnumerable{string}"/> containing the values to add, or <b>null</b>.</param>
/// <param name="collection">The <see cref="T:System.Collections.Generic.IEnumerable{string}"/> containing the values to add, or <b>null</b>.</param>
void AddRange(IEnumerable<string> collection);

void CopyTo(IList<string> destination);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ public interface IRouteValueDictionary
void Add(KeyValuePair<string, object> item, bool throwIfReservedKey);

/// <summary>
/// Adds the elements from a <see cref="System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// Adds the elements from a <see cref="T:System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// </summary>
/// <param name="items">The <see cref="System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="items">The <see cref="T:System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
void AddRange(IDictionary<string, object> items);

/// <summary>
/// Adds the elements from a <see cref="System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// Adds the elements from a <see cref="T:System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// </summary>
/// <param name="items">The <see cref="System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="items">The <see cref="T:System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="throwIfReservedKey"><c>true</c> to throw an exception if one of the keys being added is a reserved key name; otherwise, <c>false</c>.</param>
void AddRange(IDictionary<string, object> items, bool throwIfReservedKey);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,9 @@ public void AddRange(string stringToSplit, char[] separator)
}

/// <summary>
/// Adds each element of a <see cref="System.Collections.Generic.IEnumerable{string}"/> to the collection as a new meta robots value. Duplicates will be ignored.
/// Adds each element of a <see cref="T:System.Collections.Generic.IEnumerable{string}"/> to the collection as a new meta robots value. Duplicates will be ignored.
/// </summary>
/// <param name="collection">The <see cref="System.Collections.Generic.IEnumerable{string}"/> containing the values to add, or <b>null</b>.</param>
/// <param name="collection">The <see cref="T:System.Collections.Generic.IEnumerable{string}"/> containing the values to add, or <b>null</b>.</param>
public override void AddRange(IEnumerable<string> collection)
{
if (collection != null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ public void AddRange(string stringToSplit, char[] separator)
}

/// <summary>
/// Adds each element of a <see cref="System.Collections.Generic.IEnumerable{string}"/> to the collection.
/// Adds each element of a <see cref="T:System.Collections.Generic.IEnumerable{string}"/> to the collection.
/// </summary>
/// <param name="collection">The <see cref="System.Collections.Generic.IEnumerable{string}"/> containing the values to add, or <b>null</b>.</param>
/// <param name="collection">The <see cref="T:System.Collections.Generic.IEnumerable{string}"/> containing the values to add, or <b>null</b>.</param>
public override void AddRange(IEnumerable<string> collection)
{
if (collection != null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ protected override string GetCacheKey()
/// <summary>
/// Adds a new element to the dictionary with the specified key and value. If the key exists, the value will be overwritten.
/// </summary>
/// <param name="item">The KeyValuePair object that contains the key and value to add.</param>
/// <param name="key">The key of the new item to add.</param>
/// <param name="value">The value of the new item to add.</param>
public override void Add(string key, object value)
{
this.Add(key, value, true);
Expand Down Expand Up @@ -106,18 +107,18 @@ public void Add(string key, object value, bool throwIfReservedKey)
}

/// <summary>
/// Adds the elements from a <see cref="System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// Adds the elements from a <see cref="T:System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// </summary>
/// <param name="items">The <see cref="System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="items">The <see cref="T:System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
public override void AddRange(IDictionary<string, object> items)
{
this.AddRange(items, true);
}

/// <summary>
/// Adds the elements from a <see cref="System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// Adds the elements from a <see cref="T:System.Collections.Generic.IDictionary{string, object}"/>. If the key exists, the value will be overwritten.
/// </summary>
/// <param name="items">The <see cref="System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="items">The <see cref="T:System.Collections.Generic.IDictionary{string, object}"/> of items to add.</param>
/// <param name="throwIfReservedKey"><c>true</c> to throw an exception if one of the keys being added is a reserved key name; otherwise, <c>false</c>.</param>
public void AddRange(IDictionary<string, object> items, bool throwIfReservedKey)
{
Expand Down
2 changes: 1 addition & 1 deletion src/MvcSiteMapProvider/MvcSiteMapProvider/DI/Composer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace MvcSiteMapProvider.DI
{
/// <summary>
/// This is the default dependency injection composer for the MvcSiteMapProvider that is fired automatically
/// using a <see cref="WebActivatorEx.PostApplicationStartMethodAttribute"/> during application startup.
/// using a WebActivatorEx.PostApplicationStartMethodAttribute during application startup.
/// </summary>
public class Composer
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

namespace MvcSiteMapProvider.Security
{
// TODO: In version 5, need to add context back in here as a parameter.

/// <summary>
/// IAclModule contract
/// </summary>
Expand All @@ -14,7 +16,6 @@ public interface IAclModule
/// Determines whether node is accessible to user.
/// </summary>
/// <param name="siteMap">The site map.</param>
/// <param name="context">The context.</param>
/// <param name="node">The node.</param>
/// <returns>
/// <c>true</c> if accessible to user; otherwise, <c>false</c>.
Expand Down
10 changes: 6 additions & 4 deletions src/MvcSiteMapProvider/MvcSiteMapProvider/SiteMap.cs
Original file line number Diff line number Diff line change
Expand Up @@ -577,12 +577,15 @@ public virtual void HintNeighborhoodNodes(ISiteMapNode node, int upLevel, int do
/// true if security trimming is enabled and <paramref name="node"/> can be viewed by the user or security trimming is not enabled; otherwise, false.
/// </returns>
/// <exception cref="T:System.ArgumentNullException">
/// <paramref name="context"/> is null.
/// - or -
/// <paramref name="node"/> is null.
/// <paramref name="node"/> is null.
/// </exception>
public virtual bool IsAccessibleToUser(ISiteMapNode node)
{
if (node == null)
{
throw new ArgumentNullException("node");
}

// If the sitemap is still being constructed, always
// make all nodes accessible regardless of security trimming.
if (!IsReadOnly)
Expand Down Expand Up @@ -782,7 +785,6 @@ protected virtual ISiteMapNode FindSiteMapNodeFromMvc(HttpContextBase httpContex
/// <summary>
/// Finds the node that matches the MVC route.
/// </summary>
/// <param name="rootNode">The root node.</param>
/// <param name="values">The values.</param>
/// <param name="route">The route.</param>
/// <returns>
Expand Down
3 changes: 1 addition & 2 deletions src/MvcSiteMapProvider/MvcSiteMapProvider/SiteMapNode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,6 @@ public override UpdatePriority UpdatePriority
/// <summary>
/// Determines whether the node is visible.
/// </summary>
/// <param name="context">The context.</param>
/// <param name="sourceMetadata">The source metadata.</param>
/// <returns>
/// <c>true</c> if the specified node is visible; otherwise, <c>false</c>.
Expand Down Expand Up @@ -677,7 +676,7 @@ public override RouteData GetRouteData(HttpContextBase httpContext)
/// <summary>
/// Determines whether this node matches the supplied route values.
/// </summary>
/// <param name="routeValues">An IDictionary<string, object> of route values.</param>
/// <param name="routeValues">An <see cref="T:System.Collections.Generic.IDictionary{string, object}"/> of route values.</param>
/// <returns><c>true</c> if the route matches this node's RouteValues collection; otherwise <c>false</c>.</returns>
public override bool MatchesRoute(IDictionary<string, object> routeValues)
{
Expand Down
Loading

0 comments on commit bca8e5a

Please sign in to comment.