Skip to content
This repository was archived by the owner on Feb 26, 2022. It is now read-only.

Commit 32e5346

Browse files
leekelleherleekelleher
committed
More XML docs, to keep StyleCop happy 😵
1 parent a15317c commit 32e5346

6 files changed

Lines changed: 60 additions & 9 deletions

File tree

‎src/uComponents.DataTypes/DataTypeGrid/Handlers/DataTypes/BaseDataTypeHandler.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ public abstract class BaseDataTypeHandler<T> : IDataTypeHandler<T>
1616
where T : IDataType
1717
{
1818
/// <summary>
19-
/// Method for customizing the way the <see cref="T">datatype</see> value is displayed in the grid.
19+
/// Method for customizing the way the `datatype` value is displayed in the grid.
2020
/// </summary>
21-
/// <remarks>Called when the grid displays the cell value for the specified <see cref="T">datatype</see>.</remarks>
22-
/// <param name="dataType">The <see cref="T">datatype</see> instance.</param>
21+
/// <remarks>Called when the grid displays the cell value for the specified `datatype`.</remarks>
22+
/// <param name="dataType">The `datatype` instance.</param>
2323
/// <returns>The display value.</returns>
2424
public virtual string GetDisplayValue(T dataType)
2525
{
@@ -41,9 +41,9 @@ public virtual TBackingObjectType GetPropertyValue<TBackingObjectType>(T dataTyp
4141
}
4242

4343
/// <summary>
44-
/// Method for getting the backing object for the specified <see cref="T">datatype</see>.
44+
/// Method for getting the backing object for the specified `datatype`.
4545
/// </summary>
46-
/// <param name="dataType">The <see cref="T">datatype</see> instance.</param>
46+
/// <param name="dataType">The `datatype` instance.</param>
4747
/// <returns>The backing object.</returns>
4848
/// <remarks>Called when the method <see cref="GridCell.GetPropertyValue()" /> method is called on a <see cref="GridCell" />.</remarks>
4949
public virtual object GetPropertyValue(T dataType)
@@ -105,9 +105,9 @@ public virtual void Configure(T dataType, DataTypeLoadEventArgs eventArgs)
105105
/// <summary>
106106
/// Method for executing special actions before saving the editor value to the database.
107107
/// </summary>
108-
/// <param name="dataType">The <see cref="T">datatype</see> instance.</param>
108+
/// <param name="dataType">The `datatype` instance.</param>
109109
/// <param name="eventArgs">The <see cref="DataTypeSaveEventArgs"/> instance containing the event data.</param>
110-
/// <remarks>Called when the grid is saved for the specified <see cref="T">datatype</see>.</remarks>
110+
/// <remarks>Called when the grid is saved for the specified `datatype`.</remarks>
111111
public virtual void Save(T dataType, DataTypeSaveEventArgs eventArgs)
112112
{
113113
dataType.DataEditor.Save();

‎src/uComponents.DataTypes/DataTypeGrid/Model/StoredValueRowCollection.cs‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,27 @@
99

1010
namespace uComponents.DataTypes.DataTypeGrid.Model
1111
{
12+
/// <summary>
13+
/// StoredValueRowCollection class
14+
/// </summary>
1215
public class StoredValueRowCollection : List<StoredValueRow>
1316
{
1417
private IEnumerable<PreValueRow> columnConfigurations;
1518

19+
/// <summary>
20+
/// Initializes a new instance of the <see cref="StoredValueRowCollection"/> class.
21+
/// </summary>
22+
/// <param name="columnConfigurations">The column configurations.</param>
1623
public StoredValueRowCollection(IEnumerable<PreValueRow> columnConfigurations)
1724
{
1825
this.columnConfigurations = columnConfigurations;
1926
}
2027

28+
/// <summary>
29+
/// Initializes a new instance of the <see cref="StoredValueRowCollection"/> class.
30+
/// </summary>
31+
/// <param name="columnConfigurations">The column configurations.</param>
32+
/// <param name="xml">The XML.</param>
2133
public StoredValueRowCollection(IEnumerable<PreValueRow> columnConfigurations, string xml)
2234
: this(columnConfigurations)
2335
{
@@ -70,7 +82,7 @@ public StoredValueRowCollection(IEnumerable<PreValueRow> columnConfigurations, s
7082
{
7183
value.Value.Data.Value = node.InnerText;
7284
}
73-
catch (Exception ex)
85+
catch (Exception)
7486
{
7587
Helper.Log.Warn<DataType>(string.Format("DataTypeGrid", "Stored data ({0}) for '{1}' is incompatible with the datatype '{2}'", node.InnerText, value.Alias, value.Value.DataTypeName));
7688
}
@@ -87,6 +99,12 @@ public StoredValueRowCollection(IEnumerable<PreValueRow> columnConfigurations, s
8799
}
88100
}
89101

102+
/// <summary>
103+
/// Returns a <see cref="System.String" /> that represents this instance.
104+
/// </summary>
105+
/// <returns>
106+
/// A <see cref="System.String" /> that represents this instance.
107+
/// </returns>
90108
public override string ToString()
91109
{
92110
var str = string.Empty;

‎src/uComponents.DataTypes/Shared/Pages/DirectoryBrowser.aspx.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,14 @@
22
{
33
using umbraco.BusinessLogic;
44

5+
/// <summary>
6+
/// DirectoryBrowser class
7+
/// </summary>
58
public class DirectoryBrowser : Umbraco.Web.UI.Umbraco.Developer.Packages.DirectoryBrowser
69
{
10+
/// <summary>
11+
/// Initializes a new instance of the <see cref="DirectoryBrowser"/> class.
12+
/// </summary>
713
public DirectoryBrowser()
814
{
915
base.CurrentApp = "";

‎src/uComponents.DataTypes/TextstringArray/TextstringArrayData.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ public class TextstringArrayData : DefaultData
1919
private TextstringArrayOptions options;
2020

2121
/// <summary>
22-
/// Initializes a new instance of the <see cref="TextstringArrayData"/> class.
22+
/// Initializes a new instance of the <see cref="TextstringArrayData" /> class.
2323
/// </summary>
2424
/// <param name="dataType">Type of the data.</param>
25+
/// <param name="options">The options.</param>
2526
public TextstringArrayData(BaseDataType dataType, TextstringArrayOptions options)
2627
: base(dataType)
2728
{

‎src/uComponents.DataTypes/XPathTemplatableList/XPathTemplatableList.cs‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,28 @@ namespace uComponents.DataTypes.XPathTemplatableList
1515
/// </summary>
1616
public class XPathTemplatableList : uQuery.IGetProperty
1717
{
18+
/// <summary>
19+
/// Gets the selected nodes.
20+
/// </summary>
21+
/// <value>
22+
/// The selected nodes.
23+
/// </value>
1824
public IEnumerable<Node> SelectedNodes { get; private set; }
1925

26+
/// <summary>
27+
/// Gets the selected media.
28+
/// </summary>
29+
/// <value>
30+
/// The selected media.
31+
/// </value>
2032
public IEnumerable<Media> SelectedMedia { get; private set; }
2133

34+
/// <summary>
35+
/// Gets the selected members.
36+
/// </summary>
37+
/// <value>
38+
/// The selected members.
39+
/// </value>
2240
public IEnumerable<Member> SelectedMembers { get; private set; }
2341

2442
void uQuery.IGetProperty.LoadPropertyValue(string value)

‎src/uComponents.Mapping/NodeMapper.cs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,14 @@ public NodeMapper(NodeMappingEngine engine, Type destinationType, DocumentType s
150150
}
151151
}
152152

153+
/// <summary>
154+
/// Maps the node.
155+
/// </summary>
156+
/// <param name="context">The context.</param>
157+
/// <returns></returns>
158+
/// <exception cref="System.ArgumentNullException">context</exception>
159+
/// <exception cref="uComponents.Mapping.InvalidPathException">
160+
/// </exception>
153161
public object MapNode(NodeMappingContext context)
154162
{
155163
if (context == null)

0 commit comments

Comments
 (0)