From b50135678aad1e12625723887a9f5d114ffcf697 Mon Sep 17 00:00:00 2001
From: Luiz Henrique Cassettari <ricaun@gmail.com>
Date: Mon, 20 Jan 2025 18:35:23 -0300
Subject: [PATCH] Update documentation

---
 ricaun.Revit.DA/DesignApplication.cs  | 38 +++++++++++++++++++++------
 ricaun.Revit.DA/DesignApplicationT.cs | 25 ++++++++++++++++++
 ricaun.Revit.DA/IDesignAutomation.cs  | 10 +++++++
 3 files changed, 65 insertions(+), 8 deletions(-)
 create mode 100644 ricaun.Revit.DA/DesignApplicationT.cs

diff --git a/ricaun.Revit.DA/DesignApplication.cs b/ricaun.Revit.DA/DesignApplication.cs
index 56c51fa..100dc9b 100644
--- a/ricaun.Revit.DA/DesignApplication.cs
+++ b/ricaun.Revit.DA/DesignApplication.cs
@@ -7,14 +7,9 @@
 
 namespace ricaun.Revit.DA
 {
-    public abstract class DesignApplication<T> : DesignApplication where T : IDesignAutomation
-    {
-        public override bool Execute(Application application, string filePath, Document document)
-        {
-            return Activator.CreateInstance<T>().Execute(application, filePath, document);
-        }
-    }
-
+    /// <summary>
+    /// Represents a design application that executes a specific type of design automation.
+    /// </summary>
     public abstract class DesignApplication : IExternalDBApplication, IDesignAutomation
     {
         /// <summary>
@@ -25,13 +20,35 @@ public abstract class DesignApplication : IExternalDBApplication, IDesignAutomat
         /// Use DesignApplicationLoader to load the correct version of the DesignApplication based in the `PackageContents.xml` configuration.
         /// </summary>
         public virtual bool UseDesignApplicationLoader => true;
+        /// <summary>
+        /// Gets the controlled application.
+        /// </summary>
         public ControlledApplication ControlledApplication { get; private set; }
+        /// <summary>
+        /// Method called when the application starts up.
+        /// </summary>
         public virtual void OnStartup() { }
+        /// <summary>
+        /// Method called when the application shuts down.
+        /// </summary>
         public virtual void OnShutdown() { }
+        /// <summary>
+        /// Executes the design automation.
+        /// </summary>
+        /// <param name="application">The Revit application.</param>
+        /// <param name="filePath">The file path to the document.</param>
+        /// <param name="document">The Revit document.</param>
+        /// <returns>True if the execution is successful; otherwise, false.</returns>
         public abstract bool Execute(Application application, string filePath, Document document);
 
         private IExternalDBApplication designApplication;
         private DesignAutomationSingleExternalServer externalServer;
+
+        /// <summary>
+        /// Method called when the application starts up.
+        /// </summary>
+        /// <param name="application">The controlled application.</param>
+        /// <returns>The result of the external DB application startup.</returns>
         public ExternalDBApplicationResult OnStartup(ControlledApplication application)
         {
             ControlledApplication = application;
@@ -66,6 +83,11 @@ public ExternalDBApplicationResult OnStartup(ControlledApplication application)
             return ExternalDBApplicationResult.Succeeded;
         }
 
+        /// <summary>
+        /// Method called when the application shuts down.
+        /// </summary>
+        /// <param name="application">The controlled application.</param>
+        /// <returns>The result of the external DB application shutdown.</returns>
         public ExternalDBApplicationResult OnShutdown(ControlledApplication application)
         {
             ControlledApplication = application;
diff --git a/ricaun.Revit.DA/DesignApplicationT.cs b/ricaun.Revit.DA/DesignApplicationT.cs
new file mode 100644
index 0000000..f66822b
--- /dev/null
+++ b/ricaun.Revit.DA/DesignApplicationT.cs
@@ -0,0 +1,25 @@
+using Autodesk.Revit.ApplicationServices;
+using Autodesk.Revit.DB;
+using System;
+
+namespace ricaun.Revit.DA
+{
+    /// <summary>
+    /// Represents a design application that executes a specific type of design automation.
+    /// </summary>
+    /// <typeparam name="T">The type of design automation to execute.</typeparam>
+    public abstract class DesignApplication<T> : DesignApplication where T : IDesignAutomation
+    {
+        /// <summary>
+        /// Executes the design automation of type <typeparamref name="T"/>.
+        /// </summary>
+        /// <param name="application">The Revit application.</param>
+        /// <param name="filePath">The file path to the document.</param>
+        /// <param name="document">The Revit document.</param>
+        /// <returns>True if the execution is successful; otherwise, false.</returns>
+        public override bool Execute(Application application, string filePath, Document document)
+        {
+            return Activator.CreateInstance<T>().Execute(application, filePath, document);
+        }
+    }
+}
diff --git a/ricaun.Revit.DA/IDesignAutomation.cs b/ricaun.Revit.DA/IDesignAutomation.cs
index e9b40bc..c7dcf28 100644
--- a/ricaun.Revit.DA/IDesignAutomation.cs
+++ b/ricaun.Revit.DA/IDesignAutomation.cs
@@ -3,8 +3,18 @@
 
 namespace ricaun.Revit.DA
 {
+    /// <summary>
+    /// Interface for design automation tasks in Revit.
+    /// </summary>
     public interface IDesignAutomation
     {
+        /// <summary>
+        /// Executes a design automation task.
+        /// </summary>
+        /// <param name="application">The Revit application instance.</param>
+        /// <param name="filePath">The file path to the document.</param>
+        /// <param name="document">The Revit document instance.</param>
+        /// <returns>True if the task was executed successfully, otherwise false.</returns>
         bool Execute(Application application, string filePath, Document document);
     }
 }