XML comments

Author: tpluscode

RomanticWeb/Mapping/Attributes/PredicateMappingAttribute.cs

@@ -3,13 +3,25 @@
 
 namespace RomanticWeb.Mapping.Attributes
 {
+    /// <summary>
+    /// Base class for mapping an RDF predicate
+    /// </summary>
     public abstract class PredicateMappingAttribute : TermMappingAttribute
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PredicateMappingAttribute"/> class.
+        /// </summary>
+        /// <param name="prefix">The term prefix.</param>
+        /// <param name="term">The term name.</param>
         protected PredicateMappingAttribute(string prefix, string term)
             : base(prefix, term)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PredicateMappingAttribute"/> class.
+        /// </summary>
+        /// <param name="termUri">The term URI.</param>
         protected PredicateMappingAttribute(string termUri)
             : base(termUri)
         {

RomanticWeb/Mapping/Fluent/DictionaryMap.cs

@@ -32,9 +32,7 @@ public ITermPart<IDictionaryMap> Term
             }
         }
 
-        /// <summary>
-        /// Gets the dictionary key predicate map part
-        /// </summary>
+        /// <inheritdoc />
         public ITermPart<IDictionaryMap> KeyPredicate
         {
             get
@@ -43,9 +41,7 @@ public ITermPart<IDictionaryMap> KeyPredicate
             }
         }
 
-        /// <summary>
-        /// Gets the dictionary value predicate map part
-        /// </summary>
+        /// <inheritdoc />
         public ITermPart<IDictionaryMap> ValuePredicate
         {
             get
@@ -54,12 +50,14 @@ public ITermPart<IDictionaryMap> ValuePredicate
             }
         }
 
+        /// <inheritdoc />
         public IDictionaryMap ConvertKeysWith<TConverter>() where TConverter : INodeConverter
         {
             _keyMap.ConverterType = typeof(TConverter);
             return this;
         }
 
+        /// <inheritdoc />
         public IDictionaryMap ConvertValuesWith<TConverter>() where TConverter : INodeConverter
         {
             _valueMap.ConverterType = typeof(TConverter);
@@ -77,6 +75,9 @@ public override IPropertyMappingProvider Accept(IFluentMapsVisitor fluentMapsVis
         /// </summary>
         public class ValueMap : TermMap
         {
+            /// <summary>
+            /// Gets or sets the type of the converter.
+            /// </summary>
             public Type ConverterType { [return: AllowNull] get; set; }
 
             /// <summary>
@@ -93,6 +94,9 @@ public IPredicateMappingProvider Accept(IFluentMapsVisitor fluentMapsVisitor)
         /// </summary>
         public class KeyMap : TermMap
         {
+            /// <summary>
+            /// Gets or sets the type of the converter.
+            /// </summary>
             public Type ConverterType { [return: AllowNull] get; set; }
 
             /// <summary>

RomanticWeb/Mapping/Fluent/IDictionaryMap.cs

@@ -20,8 +20,14 @@ public interface IDictionaryMap
         /// </summary>
         ITermPart<IDictionaryMap> ValuePredicate { get; }
 
+        /// <summary>
+        /// Sets the converter type for dictionary keys
+        /// </summary>
         IDictionaryMap ConvertKeysWith<TConverter>() where TConverter : INodeConverter;
 
+        /// <summary>
+        /// Sets the converter type for dictionary values
+        /// </summary>
         IDictionaryMap ConvertValuesWith<TConverter>() where TConverter : INodeConverter;
     }
 }

RomanticWeb/Mapping/Providers/IPredicateMappingProvider.cs

@@ -2,6 +2,9 @@
 
 namespace RomanticWeb.Mapping.Providers
 {
+    /// <summary>
+    /// A mapping provider, which provides a predicate mapping
+    /// </summary>
     public interface IPredicateMappingProvider : ITermMappingProvider
     {
         /// <summary> Gets or sets the type of the converter.</summary>