[Documentation] Update variable names and comments

Author: Nice3point

source/Nice3point.Revit.Extensions/GeometryExtensions.cs

@@ -8,7 +8,7 @@ namespace Nice3point.Revit.Extensions;
 [PublicAPI]
 public static class DocumentValidationExtensions
 {
-    /// <param name="element">The element to check.</param>
+    /// <param name="element">The element to validate.</param>
     extension(Element element)
     {
         /// <summary>Indicates if an element can be deleted.</summary>

source/Nice3point.Revit.Extensions/UtilsExtensions/DocumentValidationExtensions.cs

@@ -8,7 +8,7 @@ namespace Nice3point.Revit.Extensions;
 [PublicAPI]
 public static class ElementTransformUtilsExtensions
 {
-    /// <param name="element">The source element</param>
+    /// <param name="element">The element to transform.</param>
     extension(Element element)
     {
         /// <summary>Determines whether element can be mirrored</summary>
@@ -96,20 +96,20 @@ public ICollection<ElementId> Copy(double deltaX, double deltaY, double deltaZ)
         }
     }
 
-    /// <param name="view">The source view</param>
+    /// <param name="view">The view to transform.</param>
     extension(View view)
     {
         /// <summary>
-        ///    Returns a transformation that is applied to elements when copying from one view to another view.
+        ///    Returns a transformation that is applied to elements when copying from this view to another view.
         /// </summary>
         /// <remarks>
-        ///    Both source and destination views must be 2D graphics views capable of drawing details and view-specific elements (floor and ceiling plans, elevations, sections, drafting views.)
-        ///    The result is a transformation needed to copy an element from drawing plane of the source view to the drawing plane of the destination view.
-        ///    The destination view can be in the same document as the source view.
-        ///    The destination view can be the same as the source view.
+        ///    Both this view and the destination view must be 2D graphics views capable of drawing details and view-specific elements (floor and ceiling plans, elevations, sections, drafting views.)
+        ///    The result is a transformation needed to copy an element from the drawing plane of this view to the drawing plane of the destination view.
+        ///    The destination view can be in the same document as this view.
+        ///    The destination view can be the same as this view.
         /// </remarks>
         /// <param name="destinationView">The destination view</param>
-        /// <returns>The transformation from source view to destination view.</returns>
+        /// <returns>The transformation from this view to the destination view.</returns>
         /// <exception cref="T:Autodesk.Revit.Exceptions.ArgumentException">
         ///    The specified view cannot be used as a source or destination for copying elements between two views.
         /// </exception>
@@ -120,16 +120,16 @@ public Transform GetTransformFromViewToView(View destinationView)
         }
     }
 
-    /// <param name="elementIds">The elements identified by id.</param>
-    extension(ICollection<ElementId> elementIds)
+    /// <param name="elements">The element ids to transform.</param>
+    extension(ICollection<ElementId> elements)
     {
         /// <summary>Determines whether elements can be mirrored.</summary>
         /// <param name="document">The document where the elements reside.</param>
         /// <returns>True if the elements can be mirrored.</returns>
         [Pure]
         public bool CanMirrorElements(Document document)
         {
-            return ElementTransformUtils.CanMirrorElements(document, elementIds);
+            return ElementTransformUtils.CanMirrorElements(document, elements);
         }
 
         /// <summary>
@@ -158,7 +158,7 @@ public bool CanMirrorElements(Document document)
         /// </exception>
         public ICollection<ElementId> CopyElements(Document document, XYZ translation)
         {
-            return ElementTransformUtils.CopyElements(document, elementIds, translation);
+            return ElementTransformUtils.CopyElements(document, elements, translation);
         }
 
         /// <summary>Copies a set of elements from source document to destination document.</summary>
@@ -201,7 +201,7 @@ public ICollection<ElementId> CopyElements(Document sourceDocument,
             Transform transform,
             CopyPasteOptions options)
         {
-            return ElementTransformUtils.CopyElements(sourceDocument, elementIds, destinationDocument, transform, options);
+            return ElementTransformUtils.CopyElements(sourceDocument, elements, destinationDocument, transform, options);
         }
 
         /// <summary>Copies a set of elements from source document to destination document.</summary>
@@ -235,7 +235,7 @@ public ICollection<ElementId> CopyElements(Document sourceDocument,
         /// </exception>
         public ICollection<ElementId> CopyElements(Document sourceDocument, Document destinationDocument)
         {
-            return ElementTransformUtils.CopyElements(sourceDocument, elementIds, destinationDocument, null, null);
+            return ElementTransformUtils.CopyElements(sourceDocument, elements, destinationDocument, null, null);
         }
 
         /// <summary>Copies a set of elements from source view to destination view.</summary>
@@ -291,7 +291,7 @@ public ICollection<ElementId> CopyElements(View sourceView,
             Transform additionalTransform,
             CopyPasteOptions options)
         {
-            return ElementTransformUtils.CopyElements(sourceView, elementIds, destinationView, additionalTransform, options);
+            return ElementTransformUtils.CopyElements(sourceView, elements, destinationView, additionalTransform, options);
         }
 
         /// <summary>Copies a set of elements from source view to destination view.</summary>
@@ -335,7 +335,7 @@ public ICollection<ElementId> CopyElements(View sourceView,
         /// </exception>
         public ICollection<ElementId> CopyElements(View sourceView, View destinationView)
         {
-            return ElementTransformUtils.CopyElements(sourceView, elementIds, destinationView, null, null);
+            return ElementTransformUtils.CopyElements(sourceView, elements, destinationView, null, null);
         }
 
         /// <summary>Mirrors a set of elements about a given plane.</summary>
@@ -367,7 +367,7 @@ public ICollection<ElementId> CopyElements(View sourceView, View destinationView
         /// </exception>
         public ICollection<ElementId> MirrorElements(Document document, Plane plane, bool mirrorCopies)
         {
-            return ElementTransformUtils.MirrorElements(document, elementIds, plane, mirrorCopies);
+            return ElementTransformUtils.MirrorElements(document, elements, plane, mirrorCopies);
         }
 
         /// <summary>Moves a set of elements by a given transformation.</summary>
@@ -385,8 +385,8 @@ public ICollection<ElementId> MirrorElements(Document document, Plane plane, boo
         /// </exception>
         public ICollection<ElementId> MoveElements(Document document, XYZ translation)
         {
-            ElementTransformUtils.MoveElements(document, elementIds, translation);
-            return elementIds;
+            ElementTransformUtils.MoveElements(document, elements, translation);
+            return elements;
         }
 
         /// <summary>Rotates a set of elements about the given axis and angle.</summary>
@@ -400,8 +400,8 @@ public ICollection<ElementId> MoveElements(Document document, XYZ translation)
         /// </exception>
         public ICollection<ElementId> RotateElements(Document document, Line axis, double angle)
         {
-            ElementTransformUtils.RotateElements(document, elementIds, axis, angle);
-            return elementIds;
+            ElementTransformUtils.RotateElements(document, elements, axis, angle);
+            return elements;
         }
     }
 }

source/Nice3point.Revit.Extensions/UtilsExtensions/ElementTransformUtilsExtensions.cs

@@ -8,7 +8,7 @@ namespace Nice3point.Revit.Extensions;
 [PublicAPI]
 public static class HostObjectUtilsExtensions
 {
-    /// <param name="host">The host object</param>
+    /// <param name="host">The host object.</param>
     extension(HostObject host)
     {
         /// <summary>Returns the bottom faces for this host object</summary>

source/Nice3point.Revit.Extensions/UtilsExtensions/HostObjectUtilsExtensions.cs

@@ -8,7 +8,7 @@ namespace Nice3point.Revit.Extensions;
 [PublicAPI]
 public static class JoinGeometryUtilsExtensions
 {
-    /// <param name="element">The source element</param>
+    /// <param name="element">The element.</param>
     extension(Element element)
     {
         /// <summary>
@@ -22,7 +22,7 @@ public static class JoinGeometryUtilsExtensions
         ///    The second element to be joined. This element must not be joined to the first element
         /// </param>
         /// <exception cref="T:Autodesk.Revit.Exceptions.ArgumentException">
-        ///    The element secondElement was not found in the source document<br />
+        ///    The element secondElement was not found in the document<br />
         ///    The elements are already joined<br />
         ///    The elements cannot be joined<br />
         /// </exception>
@@ -42,7 +42,7 @@ public void JoinGeometry(Element secondElement)
         ///    The second element to be unjoined. This element must be joined to the fist element
         /// </param>
         /// <exception cref="T:Autodesk.Revit.Exceptions.ArgumentException">
-        ///    The element secondElement was not found in the source document<br />
+        ///    The element secondElement was not found in the document<br />
         ///    The elements are not joined<br />
         ///    The elements cannot be unjoined
         /// </exception>
@@ -61,7 +61,7 @@ public void UnjoinGeometry(Element secondElement)
         /// <param name="secondElement">The second element</param>
         /// <returns>True if the two elements are joined</returns>
         /// <exception cref="T:Autodesk.Revit.Exceptions.ArgumentException">
-        ///    The element secondElement was not found in the source document
+        ///    The element secondElement was not found in the document
         /// </exception>
         [Pure]
         public bool AreElementsJoined(Element secondElement)
@@ -91,7 +91,7 @@ public ICollection<ElementId> GetJoinedElements()
         ///    The second element. This element must be joined to the first element
         /// </param>
         /// <exception cref="T:Autodesk.Revit.Exceptions.ArgumentException">
-        ///    The element secondElement was not found in the source document<br />
+        ///    The element secondElement was not found in the document<br />
         ///    The elements are not joined<br />
         ///    The elements cannot be joined
         /// </exception>
@@ -104,15 +104,15 @@ public void SwitchJoinOrder(Element secondElement)
         }
 
         /// <summary>
-        ///    Determines whether the first of two joined elements is cutting the second element
+        ///    Determines whether this element is cutting the second element in a join
         /// </summary>
         /// <remarks>This functionality is not available for family documents</remarks>
         /// <param name="secondElement">The second element</param>
         /// <returns>
-        ///    True if the secondElement is cut by the element, false if the secondElement is cut by the element
+        ///    True if this element is cutting the secondElement, false if the secondElement is cutting this element
         /// </returns>
         /// <exception cref="T:Autodesk.Revit.Exceptions.ArgumentException">
-        ///    The element secondElement was not found in the source document<br />
+        ///    The element secondElement was not found in the document<br />
         ///    The elements are not joined
         /// </exception>
         [Pure]

source/Nice3point.Revit.Extensions/UtilsExtensions/JoinGeometryUtilsExtensions.cs

@@ -1,4 +1,4 @@
-using Autodesk.Revit.ApplicationServices;
+using Autodesk.Revit.ApplicationServices;
 
 // ReSharper disable once CheckNamespace
 namespace Nice3point.Revit.Extensions;
@@ -10,8 +10,8 @@ namespace Nice3point.Revit.Extensions;
 public static class LabelUtilsExtensions
 {
 #if REVIT2021_OR_GREATER
-    /// <param name="forgeTypeId">Unique identifier</param>
-    extension(ForgeTypeId forgeTypeId)
+    /// <param name="typeId">Unique identifier</param>
+    extension(ForgeTypeId typeId)
     {
         /// <summary>
         ///     Gets the user-visible name for a spec
@@ -26,7 +26,7 @@ public static class LabelUtilsExtensions
         [Pure]
         public string ToSpecLabel()
         {
-            return LabelUtils.GetLabelForSpec(forgeTypeId);
+            return LabelUtils.GetLabelForSpec(typeId);
         }
 
         /// <summary>
@@ -39,7 +39,7 @@ public string ToSpecLabel()
         [Pure]
         public string ToSymbolLabel()
         {
-            return LabelUtils.GetLabelForSymbol(forgeTypeId);
+            return LabelUtils.GetLabelForSymbol(typeId);
         }
 
         /// <summary>
@@ -52,7 +52,7 @@ public string ToSymbolLabel()
         [Pure]
         public string ToUnitLabel()
         {
-            return LabelUtils.GetLabelForUnit(forgeTypeId);
+            return LabelUtils.GetLabelForUnit(typeId);
         }
 
 #if REVIT2022_OR_GREATER
@@ -66,7 +66,7 @@ public string ToUnitLabel()
         [Pure]
         public string ToDisciplineLabel()
         {
-            return LabelUtils.GetLabelForDiscipline(forgeTypeId);
+            return LabelUtils.GetLabelForDiscipline(typeId);
         }
 
         /// <summary>
@@ -79,14 +79,14 @@ public string ToDisciplineLabel()
         [Pure]
         public string ToLabel()
         {
-            if (forgeTypeId.Empty()) return string.Empty;
+            if (typeId.Empty()) return string.Empty;
 
-            if (ParameterUtils.IsBuiltInParameter(forgeTypeId)) return LabelUtils.GetLabelForBuiltInParameter(forgeTypeId);
-            if (ParameterUtils.IsBuiltInGroup(forgeTypeId)) return LabelUtils.GetLabelForGroup(forgeTypeId);
-            if (UnitUtils.IsUnit(forgeTypeId)) return LabelUtils.GetLabelForUnit(forgeTypeId);
-            if (UnitUtils.IsSymbol(forgeTypeId)) return LabelUtils.GetLabelForSymbol(forgeTypeId);
-            if (SpecUtils.IsSpec(forgeTypeId)) return LabelUtils.GetLabelForSpec(forgeTypeId);
-            return LabelUtils.GetLabelForDiscipline(forgeTypeId);
+            if (ParameterUtils.IsBuiltInParameter(typeId)) return LabelUtils.GetLabelForBuiltInParameter(typeId);
+            if (ParameterUtils.IsBuiltInGroup(typeId)) return LabelUtils.GetLabelForGroup(typeId);
+            if (UnitUtils.IsUnit(typeId)) return LabelUtils.GetLabelForUnit(typeId);
+            if (UnitUtils.IsSymbol(typeId)) return LabelUtils.GetLabelForSymbol(typeId);
+            if (SpecUtils.IsSpec(typeId)) return LabelUtils.GetLabelForSpec(typeId);
+            return LabelUtils.GetLabelForDiscipline(typeId);
         }
 
         /// <summary>
@@ -98,7 +98,7 @@ public string ToLabel()
         [Pure]
         public string ToGroupLabel()
         {
-            return LabelUtils.GetLabelForGroup(forgeTypeId);
+            return LabelUtils.GetLabelForGroup(typeId);
         }
 
         /// <summary>
@@ -111,14 +111,14 @@ public string ToGroupLabel()
         [Pure]
         public string ToParameterLabel()
         {
-            return LabelUtils.GetLabelForBuiltInParameter(forgeTypeId);
+            return LabelUtils.GetLabelForBuiltInParameter(typeId);
         }
 #endif
     }
 #endif
 
-    /// <param name="builtInParameter">The builtin parameter</param>
-    extension(BuiltInParameter builtInParameter)
+    /// <param name="parameter">The builtin parameter</param>
+    extension(BuiltInParameter parameter)
     {
         /// <summary>
         ///     Gets the user-visible name for a BuiltInParameter
@@ -130,7 +130,7 @@ public string ToParameterLabel()
         [Pure]
         public string ToLabel()
         {
-            return LabelUtils.GetLabelFor(builtInParameter);
+            return LabelUtils.GetLabelFor(parameter);
         }
 
         /// <summary>
@@ -147,12 +147,12 @@ public string ToLabel()
         [Pure]
         public string ToLabel(LanguageType language)
         {
-            return LabelUtils.GetLabelFor(builtInParameter, language);
+            return LabelUtils.GetLabelFor(parameter, language);
         }
     }
 
-    /// <param name="builtInCategory">The builtin category</param>
-    extension(BuiltInCategory builtInCategory)
+    /// <param name="category">The builtin category</param>
+    extension(BuiltInCategory category)
     {
         /// <summary>
         ///     Gets the user-visible name for a BuiltInCategory
@@ -164,25 +164,25 @@ public string ToLabel(LanguageType language)
         [Pure]
         public string ToLabel()
         {
-            return LabelUtils.GetLabelFor(builtInCategory);
+            return LabelUtils.GetLabelFor(category);
         }
     }
 
 #if !REVIT2025_OR_GREATER
-    /// <param name="builtInParameterGroup">The builtin parameter group</param>
-    extension(BuiltInParameterGroup builtInParameterGroup)
+    /// <param name="parameterGroup">The builtin parameter group</param>
+    extension(BuiltInParameterGroup parameterGroup)
     {
         /// <summary>
         ///     Gets the user-visible name for a BuiltInParameterGroup
         /// </summary>
         /// <remarks>The name is obtained in the current Revit language</remarks>
         [Pure]
 #if REVIT2024
-        [Obsolete("This method is deprecated in Revit 2024 and may be removed in a future version of Revit. Please use the `GetLabelForGroup(ForgeTypeId)` method instead.")]
+        [Obsolete("This method is deprecated in Revit 2024 and may be removed in a future version of Revit. Please use the `GetLabelForGroup(typeId)` method instead.")]
 #endif
         public string ToLabel()
         {
-            return LabelUtils.GetLabelFor(builtInParameterGroup);
+            return LabelUtils.GetLabelFor(parameterGroup);
         }
     }