Mostly XML documentation

Author: abjerner

src/Skybrud.Umbraco.MultiNodeTreePicker/Composers/MntpConverterCollection.cs

@@ -5,11 +5,18 @@
 
 namespace Skybrud.Umbraco.MultiNodeTreePicker.Composers {
 
+    /// <summary>
+    /// Class representing a collection of <see cref="IMntpItemConverter"/>.
+    /// </summary>
     public sealed class MntpConverterCollection : BuilderCollectionBase<IMntpItemConverter> {
 
         private readonly Dictionary<string, IMntpItemConverter> _lookup;
 
-        public MntpConverterCollection(Func<IEnumerable<IMntpItemConverter>> items) : base(items) {
+        /// <summary>
+        /// Initializes an new instance based on the specified <paramref name="converters"/>.
+        /// </summary>
+        /// <param name="converters">The item converters that should make up the collection.</param>
+        public MntpConverterCollection(Func<IEnumerable<IMntpItemConverter>> converters) : base(converters) {
 
             _lookup = new Dictionary<string, IMntpItemConverter>(StringComparer.OrdinalIgnoreCase);
 
@@ -24,8 +31,17 @@ public MntpConverterCollection(Func<IEnumerable<IMntpItemConverter>> items) : ba
 
         }
 
-        public bool TryGet(string typeName, out IMntpItemConverter item) {
-            return _lookup.TryGetValue(typeName, out item);
+        /// <summary>
+        /// Gets the item converter associated with the specified <paramref name="typeName"/>.
+        /// </summary>
+        /// <param name="typeName">The name of the type.</param>
+        /// <param name="result">When this method returns, contains the item converter associated with the specified
+        /// <paramref name="typeName"/>, if the key is found; otherwise <c>null</c>. This parameter is passed
+        /// uninitialized.</param>
+        /// <returns><c>true</c> if the collection contains an item converter with the specified
+        /// <paramref name="typeName"/>; otherwise, false.</returns>
+        public bool TryGet(string typeName, out IMntpItemConverter result) {
+            return _lookup.TryGetValue(typeName, out result);
         }
 
     }

src/Skybrud.Umbraco.MultiNodeTreePicker/Controllers/MntpController.cs

@@ -3,6 +3,8 @@
 using Umbraco.Cms.Web.BackOffice.Controllers;
 using Umbraco.Cms.Web.Common.Attributes;
 
+#pragma warning disable 1591
+
 namespace Skybrud.Umbraco.MultiNodeTreePicker.Controllers {
 
     [PluginController("Skybrud")]

src/Skybrud.Umbraco.MultiNodeTreePicker/Converters/IMntpItemConverter.cs

@@ -4,13 +4,30 @@
 
 namespace Skybrud.Umbraco.MultiNodeTreePicker.Converters {
 
+    /// <summary>
+    /// Interface describing an item converter.
+    /// </summary>
     public interface IMntpItemConverter {
 
+        /// <summary>
+        /// Gets the friendly name of the item converter.
+        /// </summary>
         [JsonProperty("name")]
         string Name { get; }
 
+        /// <summary>
+        /// Returns the converted item based on <paramref name="source"/>.
+        /// </summary>
+        /// <param name="propertyType">The property type.</param>
+        /// <param name="source">The source <see cref="IPublishedContent"/>.</param>
+        /// <returns>The converted item.</returns>
         object Convert(IPublishedPropertyType propertyType, IPublishedContent source);
 
+        /// <summary>
+        /// Returns the <see cref="Type"/> of the items returned by this item converter.
+        /// </summary>
+        /// <param name="propertyType">The property type.</param>
+        /// <returns>The <see cref="Type"/> of the items returned by this item converter.</returns>
         Type GetType(IPublishedPropertyType propertyType);
 
     }

src/Skybrud.Umbraco.MultiNodeTreePicker/Converters/MntpGenericItemConverter.cs

@@ -3,21 +3,49 @@
 
 namespace Skybrud.Umbraco.MultiNodeTreePicker.Converters {
 
+    /// <summary>
+    /// Generic item converter implementing the <see cref="IMntpItemConverter"/>.
+    ///
+    /// The item converter works by specifying a callback method which then will be used for converting the items.
+    /// </summary>
+    /// <typeparam name="T">The type of the items.</typeparam>
     public abstract class MntpGenericItemConverter<T> : IMntpItemConverter {
-
+        
+        /// <summary>
+        /// Gets the friendly name of the item converter.
+        /// </summary>
         public string Name { get; }
 
+        /// <summary>
+        /// Gets a reference to the callback function used for converting the items.
+        /// </summary>
         protected Func<IPublishedContent, T> Callback { get; }
 
+        /// <summary>
+        /// Initializes a new instance based on the specified <paramref name="name"/> and <paramref name="callback"/>.
+        /// </summary>
+        /// <param name="name">The friendly name of the item converter.</param>
+        /// <param name="callback">The callback function used for converting the items.</param>
         protected MntpGenericItemConverter(string name, Func<IPublishedContent, T> callback) {
             Name = name;
             Callback = callback;
         }
-
+        
+        /// <summary>
+        /// Returns the converted item based on <paramref name="source"/>.
+        /// </summary>
+        /// <param name="propertyType">The property type.</param>
+        /// <param name="source">The source <see cref="IPublishedContent"/>.</param>
+        /// <returns>The converted item.</returns>
         public virtual object Convert(IPublishedPropertyType propertyType, IPublishedContent source) {
             return source is null ? null : Callback(source);
         }
-
+        
+        /// <summary>
+        /// Returns the <see cref="Type"/> of the items returned by this item converter.
+        /// </summary>
+        /// <param name="propertyType">The property type.</param>
+        /// <returns>The <see cref="Type"/> of the items returned by this item converter.</returns>
         public virtual Type GetType(IPublishedPropertyType propertyType) {
             return typeof(T);
         }

src/Skybrud.Umbraco.MultiNodeTreePicker/Converters/MntpItemConverterBase.cs

@@ -3,16 +3,38 @@
 
 namespace Skybrud.Umbraco.MultiNodeTreePicker.Converters {
 
+    /// <summary>
+    /// Generic item converter base implementing the <see cref="IMntpItemConverter"/>.
+    /// </summary>
+    /// <typeparam name="T">The type of the items.</typeparam>
     public abstract class MntpItemConverterBase<T> : IMntpItemConverter {
-
+        
+        /// <summary>
+        /// Gets the friendly name of the item converter.
+        /// </summary>
         public string Name { get; }
-
+        
+        /// <summary>
+        /// Initializes a new instance based on the specified <paramref name="name"/>.
+        /// </summary>
+        /// <param name="name">The friendly name of the item converter.</param>
         protected MntpItemConverterBase(string name) {
             Name = name;
         }
-
+        
+        /// <summary>
+        /// Returns the converted item based on <paramref name="source"/>.
+        /// </summary>
+        /// <param name="propertyType">The property type.</param>
+        /// <param name="source">The source <see cref="IPublishedContent"/>.</param>
+        /// <returns>The converted item.</returns>
         public abstract object Convert(IPublishedPropertyType propertyType, IPublishedContent source);
-
+        
+        /// <summary>
+        /// Returns the <see cref="Type"/> of the items returned by this item converter.
+        /// </summary>
+        /// <param name="propertyType">The property type.</param>
+        /// <returns>The <see cref="Type"/> of the items returned by this item converter.</returns>
         public virtual Type GetType(IPublishedPropertyType propertyType) {
             return typeof(T);
         }

src/Skybrud.Umbraco.MultiNodeTreePicker/PropertyEditors/MntpConfiguration.cs

@@ -3,8 +3,14 @@
 
 namespace Skybrud.Umbraco.MultiNodeTreePicker.PropertyEditors {
 
+    /// <summary>
+    /// Class representing the configuration of a <see cref="MntpEditor"/> data type.
+    /// </summary>
     public class MntpConfiguration : MultiNodePickerConfiguration {
 
+        /// <summary>
+        /// Gets or sets an instance of <see cref="JObject"/> representing the information about the selected item converter.
+        /// </summary>
         [ConfigurationField("itemConverter", "Item converter", "/App_Plugins/Skybrud.Umbraco.MultiNodeTreePicker/MntpConverter.html", Description = "Select an item converter.")]
         public JObject ItemConverter { get; set; }
 

src/Skybrud.Umbraco.MultiNodeTreePicker/PropertyEditors/MntpConfigurationEditor.cs

@@ -2,6 +2,8 @@
 using Umbraco.Cms.Core.IO;
 using Umbraco.Cms.Core.PropertyEditors;
 
+#pragma warning disable 1591
+
 namespace Skybrud.Umbraco.MultiNodeTreePicker.PropertyEditors {
 
     public class MntpConfigurationEditor : ConfigurationEditor<MntpConfiguration> {

src/Skybrud.Umbraco.MultiNodeTreePicker/PropertyEditors/MntpEditor.cs

@@ -1,19 +1,27 @@
 using Umbraco.Cms.Core.IO;
 using Umbraco.Cms.Core.PropertyEditors;
 
+#pragma warning disable 1591
+
 namespace Skybrud.Umbraco.MultiNodeTreePicker.PropertyEditors {
 
     [DataEditor(EditorAlias, "Skybrud Multinode Treepicker", EditorView, ValueType = ValueTypes.Text, Group = "Skybrud.dk", Icon = "icon-page-add color-skybrud")]
     public class MntpEditor : MultiNodeTreePickerPropertyEditor {
 
-        internal const string EditorAlias = "Skybrud.Umbraco.MultiNodeTreePicker";
+        /// <summary>
+        /// Gets the alias of the property editor.
+        /// </summary>
+        public const string EditorAlias = "Skybrud.Umbraco.MultiNodeTreePicker";
 
-        internal const string EditorView = "contentpicker";
+        /// <summary>
+        /// Gets the view of the property editor.
+        /// </summary>
+        public const string EditorView = "contentpicker";
 
         private readonly IIOHelper _iOHelper;
 
         public MntpEditor(IDataValueEditorFactory dataValueEditorFactory, IIOHelper iOHelper) : base(dataValueEditorFactory, iOHelper) {
-            this._iOHelper = iOHelper;
+            _iOHelper = iOHelper;
         }
 
         protected override IConfigurationEditor CreateConfigurationEditor() {

src/Skybrud.Umbraco.MultiNodeTreePicker/PropertyEditors/ValueConverters/MntpValueConverter.cs

@@ -14,6 +14,8 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Web;
 
+#pragma warning disable 1591
+
 namespace Skybrud.Umbraco.MultiNodeTreePicker.PropertyEditors.ValueConverters {
 
     public class MntpValueConverter : MultiNodeTreePickerValueConverter {