Chang UserManualRus

StructureHelperLogics/Models/BeamShears/IBeamShearSectionLogicResult.cs

@@ -1,21 +1,36 @@
 using StructureHelperCommon.Models;
 using StructureHelperCommon.Models.Calculators;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Security.Policy;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace StructureHelperLogics.Models.BeamShears
 {
+    /// <summary>
+    /// Implements result of calculating of strength of inclined section fore shear
+    /// </summary>
     public interface IBeamShearSectionLogicResult : IResult
     {
+        /// <summary>
+        /// Reference back to input data for calculating
+        /// </summary>
         IBeamShearSectionLogicInputData InputData { get; set; }
+        /// <summary>
+        /// Ultimate shear force due to cocrete
+        /// </summary>
         public double ConcreteStrength { get; set; }
+        /// <summary>
+        /// Ultimate shear force due to stirrups
+        /// </summary>
         public double StirrupStrength { get; set; }
+        /// <summary>
+        /// Total ultimate strength
+        /// </summary>
         public double TotalStrength { get; set; }
+        /// <summary>
+        /// Ration of load to total strength
+        /// </summary>
         public double FactorOfUsing { get; }
+        /// <summary>
+        /// Trace of calculating
+        /// </summary>
         public IShiftTraceLogger TraceLogger { get; }
     }
 }

StructureHelperLogics/Models/BeamShears/IInclinedSection.cs

@@ -4,7 +4,7 @@ using StructureHelperCommon.Infrastructures.Interfaces;
 namespace StructureHelperLogics.Models.BeamShears
 {
     /// <summary>
-    /// Implement parameers of inclined cross-section for beam shear calculating
+    /// Implement parameters of inclined cross-section for beam shear calculating
     /// </summary>
     public interface IInclinedSection : IEffectiveDepth
     {

StructureHelperLogics/Models/BeamShears/Logics/BeamShearSectionLogic.cs

@@ -1,5 +1,4 @@
-using StructureHelperCommon.Infrastructures.Exceptions;
-using StructureHelperCommon.Infrastructures.Interfaces;
+using StructureHelperCommon.Infrastructures.Interfaces;
 using StructureHelperCommon.Models;
 using StructureHelperCommon.Models.Calculators;
 using StructureHelperCommon.Models.Loggers;

StructureHelperLogics/Models/BeamShears/Logics/CoordinateByLevelLogic.cs

@@ -1,13 +1,9 @@
 using StructureHelperCommon.Infrastructures.Exceptions;
 using StructureHelperCommon.Models;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace StructureHelperLogics.Models.BeamShears
 {
+    /// <inheritdoc/>
     public class CoordinateByLevelLogic : ICoordinateByLevelLogic
     {
         public IShiftTraceLogger? TraceLogger { get; set; }
@@ -17,6 +13,7 @@ namespace StructureHelperLogics.Models.BeamShears
             TraceLogger = traceLogger;
         }
 
+        /// <inheritdoc/>
         public double GetCoordinate(double startCoord, double endCoord, double relativeLevel)
         {
             CheckRelativeLevel(relativeLevel);

StructureHelperLogics/Models/BeamShears/Logics/ICoordinateByLevelLogic.cs

@@ -1,14 +1,19 @@
 using StructureHelperCommon.Infrastructures.Interfaces;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace StructureHelperLogics.Models.BeamShears
 {
+    /// <summary>
+    /// Implements logic of calculating of coordinate of point where source level intersect inclinid section
+    /// </summary>
     public interface ICoordinateByLevelLogic : ILogic
     {
+        /// <summary>
+        /// Calculates coordinate of point where aource level intersect inclined section
+        /// </summary>
+        /// <param name="startCoord">Start coordinate of inclined section</param>
+        /// <param name="endCoord">End coordinate of inclined section</param>
+        /// <param name="relativeLevel">Source relative level, 0.5 - top level, -0.5 bottom level</param>
+        /// <returns></returns>
         double GetCoordinate(double startCoord, double endCoord, double relativeLevel);
     }
 }

StructureHelperLogics/Models/BeamShears/Logics/IDirectShearForceLogicInputData.cs

@@ -4,6 +4,9 @@ using StructureHelperCommon.Models.Forces;
 
 namespace StructureHelperLogics.Models.BeamShears
 {
+    /// <summary>
+    /// Implements input data fore calculating forces at the and of inclined section
+    /// </summary>
     public interface IDirectShearForceLogicInputData : IInputData
     {
         IBeamShearAction BeamShearAction { get; set; }

StructureHelperLogics/Models/BeamShears/Logics/StirrupBySearchLogic.cs

@@ -1,7 +1,6 @@
 using StructureHelperCommon.Infrastructures.Exceptions;
 using StructureHelperCommon.Models;
 using StructureHelperCommon.Models.Calculators;
-using StructureHelperLogics.Models.BeamShears.Logics;
 
 namespace StructureHelperLogics.Models.BeamShears
 {