Atualização da Documentação

gpfernando2024 · Oct 31, 2024 · 6a6ece6 · 6a6ece6
1 parent 80c1ec2
commit 6a6ece6
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 2 deletions.
diff --git a/Controllers/DailyReportController .cs b/Controllers/DailyReportController .cs
@@ -62,6 +62,9 @@ Campos DevOps Analytics
 namespace GestaoDemandas.Controllers
 {
 
+    /// <summary>
+    /// Classe que representa Report Diário - Status Report gerando em documento DOCX
+    /// </summary>
     public class DailyReportController : Controller
     {
         private static readonly string AzureAnalyticsUrl = "https://analytics.dev.azure.com/devopssee/CFIEE%20-%20Coordenadoria%20de%20Finan%C3%A7as%20e%20Infra%20Estrutura%20Escolar/_odata/v4.0-preview/WorkItems?$filter=(indexof(Custom_Sistema, 'Transporte Escolar') ge 0 or indexof(Custom_Sistema, 'Indicação Escolas PEI') ge 0 or indexof(Custom_Sistema, 'PLACON') ge 0) and WorkItemType eq 'User Story'        &$select=WorkItemId,TagNames, Custom_Atividade,Title,State,Custom_Sistema,Custom_Prioridade_Epic,Custom_Finalidade,Custom_NomeProjeto, Custom_SemanaProdesp,Custom_EntregaValor, Custom_4c82d7ee__002Dbf7c__002D4b3f__002Db22f__002D0f09ef055fcc, Custom_dd460af2__002D5f88__002D4581__002D8205__002De63c777ecef9,Custom_b4f03334__002D2822__002D4015__002D8439__002D3f002a94bf8e,Custom_b4f03334__002D2822__002D4015__002D8439__002D3f002a94bf8e,CreatedDate,Custom_DataInicioAtendimento,Custom_DataPrevistaDaEntrega,Custom_c4b5f670__002D39f1__002D40fd__002Dace5__002D329f6170c36d,Custom_e9e5e387__002D39de__002D4875__002D94a5__002Db5721f8e21ef&$expand=AssignedTo($select=UserName),Teams($select=TeamName),BoardLocations($select=ColumnName,IsDone,BoardName)&$orderby=CreatedDate desc";
@@ -71,12 +74,22 @@ public class DailyReportController : Controller
 
         private SituacaoAtividade Status;
 
+        /// <summary>
+        /// Classe que representa a lista em tela das atividades no formato Report Diário
+        /// </summary>
+        /// <returns></returns>
         public async Task<ActionResult> StatusReport()
         {
             var model = await GetDailyReportData();
             return View(model);
         }
 
+        /// <summary>
+        /// Classe que representa a geração do Report Diário em DOCX
+        /// </summary>
+        /// <param name="model"></param>
+        /// <returns></returns>
+        /// <exception cref="ApplicationException"></exception>
         public async Task<ActionResult> GenerateDocx(DailyReportViewModel model)
         {
             var currentDate = DateTime.Now.ToString("dd/MM/yyyy");

diff --git a/Controllers/HomeController.cs b/Controllers/HomeController.cs
@@ -6,20 +6,35 @@
 
 namespace GestaoDemandas.Controllers
 {
+    /// <summary>
+    /// Classe que representa a tela de inicio
+    /// </summary>
     public class HomeController : Controller
     {
+        /// <summary>
+        /// Classe inicio 
+        /// </summary>
+        /// <returns></returns>
         public ActionResult Index()
         {
             return View();
         }
 
+        /// <summary>
+        /// Classe desabilitada
+        /// </summary>
+        /// <returns></returns>
         public ActionResult About()
         {
             ViewBag.Message = "Your application description page.";
 
             return View();
         }
 
+        /// <summary>
+        /// Classe desabilitada
+        /// </summary>
+        /// <returns></returns>
         public ActionResult Contact()
         {
             ViewBag.Message = "Your contact page.";

diff --git a/Controllers/WorkItemsController.cs b/Controllers/WorkItemsController.cs
@@ -43,6 +43,9 @@ Campos DevOps Analytics
 
 namespace GestaoDemandas.Controllers
 {
+ /// <summary>
+ /// Classe que representa controle do lista de atividade - WorkItems Analytics
+ /// </summary>
     public class WorkItemsController : Controller
     {
         private static readonly HttpClient httpClient;
@@ -60,6 +63,26 @@ static WorkItemsController()
                 Convert.ToBase64String(System.Text.ASCIIEncoding.ASCII.GetBytes($":{pat}")));
         }
 
+        /// <summary>
+        /// Classe que representa a lista de atividades no Azure DevOps (Boards)
+        /// Possui filtros de pesquisa
+        /// </summary>
+        /// <param name="searchId"></param>
+        /// <param name="searchDataAbertura"></param>
+        /// <param name="searchDataPrevisaoEntrega"></param>
+        /// <param name="searchDataFechamento"></param>
+        /// <param name="searchDataInicio"></param>
+        /// <param name="searchDataConclusao"></param>
+        /// <param name="searchDataRealEntrega"></param>
+        /// <param name="searchStatus"></param>
+        /// <param name="searchPrioridade"></param>
+        /// <param name="searchSistema"></param>
+        /// <param name="searchTeam"></param>
+        /// <param name="team"></param>
+        /// <param name="clear"></param>
+        /// <param name="page"></param>
+        /// <param name="pageSize"></param>
+        /// <returns></returns>
         public async Task<ActionResult> Index(string searchId, string searchDataAbertura, string searchDataPrevisaoEntrega,  string searchDataFechamento,  string searchDataInicio, string searchDataConclusao, string searchDataRealEntrega,   string searchStatus, string searchPrioridade, string searchSistema, string searchTeam, string team, bool clear = false, int page = 1, int pageSize = 160)
         {
             if (clear)

diff --git a/Enumeradores/Enum.cs b/Enumeradores/Enum.cs
@@ -10,6 +10,9 @@
 
 namespace GestaoDemandas.Enumeradores
 {
+    /// <summary>
+    /// Classe que representa Enumeração da situação padrão da atividade Azure DevOps
+    /// </summary>
     public enum SituacaoAtividade
     {
         /*Status Atividade: 
@@ -22,20 +25,54 @@ public enum SituacaoAtividade
          Deploy Producao = 7,
          Aguardando Solicitante = 8
          */
-
+        /// <summary>
+        /// Enumeração - Aberto = 0
+        /// </summary>
         Aberto,
+        /// <summary>
+        /// Enumeração - Concluido = 1
+        /// </summary>
         Concluido,
+        /// <summary>
+        /// Enumeração - SuspensoTemp = 2
+        /// </summary>
         SuspensoTemp,
+        /// <summary>
+        /// Enumeração - Desenvolvimento = 3
+        /// </summary>
         Desenvolvimento,
+        /// <summary>
+        /// Enumeração - AguardandoSolicitante = 4
+        /// </summary>
         AguardandoSolicitante,
+        /// <summary>
+        /// Enumeração - Suspenso = 5
+        /// </summary>
         Suspenso,
+        /// <summary>
+        /// Enumeração - Análise = 6
+        /// </summary>
         Análise,
+        /// <summary>
+        /// Enumeração - Homologacao = 7
+        /// </summary>
         Homologacao,
+        /// <summary>
+        /// Enumeração - DeployProducao = 8
+        /// </summary>
         DeployProducao,
+        /// <summary>
+        /// Enumeração - AguardandoDesenvolvimento = 9
+        /// </summary>
         AguardandoDesenvolvimento,
+        /// <summary>
+        /// Enumeração - RevisãoTecnica = 10
+        /// </summary>
         RevisãoTecnica
     }
-
+    /// <summary>
+    /// Classe enumeração definido complemento da observação 
+    /// </summary>
     public enum Complemento
     {
         EmTeste,