xmldoc

Author: pavel-b-novikov

Reinforced.Typings/Attributes/INameOverrideAttribute.cs

@@ -6,13 +6,25 @@
 
 namespace Reinforced.Typings.Attributes
 {
+    /// <summary>
+    /// Configuration interface for members supporting names overriding
+    /// </summary>
     public interface INameOverrideAttribute
     {
+        /// <summary>
+        /// Name override
+        /// </summary>
         string Name { get; set; }
     }
 
+    /// <summary>
+    /// Configuration interface for members supporting camelCasing from attribute
+    /// </summary>
     public interface ICamelCaseableAttribute
     {
+        /// <summary>
+        /// camelCase flag
+        /// </summary>
         bool ShouldBeCamelCased { get; set; }
     }
 }

Reinforced.Typings/Fluent/Interfaces/IClassConfigurationBuilder.cs

@@ -2,6 +2,9 @@
 
 namespace Reinforced.Typings.Fluent.Interfaces
 {
+    /// <summary>
+    /// Technical interface for class configuration builder
+    /// </summary>
     public interface IClassConfigurationBuilder : ITypeConfigurationBuilder,
         IExportConfiguration<TsClassAttribute>
     {

Reinforced.Typings/Fluent/Interfaces/IEnumConfigurationBuidler.cs

@@ -5,9 +5,19 @@
 
 namespace Reinforced.Typings.Fluent.Interfaces
 {
+    /// <summary>
+    /// Technical interface for enumeration configuration builder
+    /// </summary>
     public interface IEnumConfigurationBuidler : IExportConfiguration<TsEnumAttribute>, IReferenceConfigurationBuilder
     {
+        /// <summary>
+        /// Type of enumeration
+        /// </summary>
         Type EnumType { get; }
+        
+        /// <summary>
+        /// Configurations for exported particular enumeration values
+        /// </summary>
         Dictionary<FieldInfo, EnumValueExportConfiguration> ValueExportConfigurations { get; }
     }
 }

Reinforced.Typings/Fluent/Interfaces/IExportConfiguration.cs

@@ -1,7 +1,14 @@
 namespace Reinforced.Typings.Fluent.Interfaces
 {
+    /// <summary>
+    /// Core fluent export configuration interface
+    /// </summary>
+    /// <typeparam name="TAttributePrototype">Attribute prototype for specified member</typeparam>
     public interface IExportConfiguration<out TAttributePrototype>
     {
+        /// <summary>
+        /// Attribute prototype
+        /// </summary>
         TAttributePrototype AttributePrototype { get; }
     }
 }

Reinforced.Typings/Fluent/Interfaces/IIgnorable.cs

@@ -1,7 +1,13 @@
 namespace Reinforced.Typings.Fluent.Interfaces
 {
+    /// <summary>
+    /// Configuration for members that are supporting ignoring
+    /// </summary>
     public interface IIgnorable
     {
+        /// <summary>
+        /// Ignore flag
+        /// </summary>
         bool Ignore { get; set; }
     }
 }

Reinforced.Typings/Fluent/Interfaces/IInterfaceConfigurationBuilder.cs

@@ -2,6 +2,9 @@
 
 namespace Reinforced.Typings.Fluent.Interfaces
 {
+    /// <summary>
+    /// Technical interface for interface configuration builder
+    /// </summary>
     public interface IInterfaceConfigurationBuilder : ITypeConfigurationBuilder,
         IExportConfiguration<TsInterfaceAttribute>
     {

Reinforced.Typings/Fluent/Interfaces/IReferenceConfigurationBuilder.cs

@@ -3,8 +3,14 @@
 
 namespace Reinforced.Typings.Fluent.Interfaces
 {
+    /// <summary>
+    /// Configuration interface for members supporting custom typescript-per-file references
+    /// </summary>
     public interface IReferenceConfigurationBuilder
     {
+        /// <summary>
+        /// Reference paths list
+        /// </summary>
         ICollection<TsAddTypeReferenceAttribute> References { get; }
     }
 }

Reinforced.Typings/Fluent/Interfaces/ITypeConfigurationBuilder.cs

@@ -5,10 +5,24 @@
 
 namespace Reinforced.Typings.Fluent.Interfaces
 {
+    /// <summary>
+    /// Technical interface for type (class/interface) configuration builder
+    /// </summary>
     public interface ITypeConfigurationBuilder : IReferenceConfigurationBuilder
     {
+        /// <summary>
+        /// Configurations for method parameters
+        /// </summary>
         Dictionary<ParameterInfo, IExportConfiguration<TsParameterAttribute>> ParametersConfiguration { get; }
+
+        /// <summary>
+        /// Configurations for type members
+        /// </summary>
         Dictionary<MemberInfo, IExportConfiguration<TsAttributeBase>> MembersConfiguration { get; }
+
+        /// <summary>
+        /// Type is being configured
+        /// </summary>
         Type Type { get; } 
     }
 }

Reinforced.Typings/Xmldoc/DocumentationManager.cs

@@ -30,7 +30,7 @@ internal DocumentationManager(string[] docFilePath)
             }
         }
 
-        public void CacheDocumentation(string docFilePath)
+        internal void CacheDocumentation(string docFilePath)
         {
             if (string.IsNullOrEmpty(docFilePath)) return;
             if (!File.Exists(docFilePath)) return;