Merge pull request #44 from Salgado2004/docs

feat: docs
Salgado2004 · Jun 12, 2024 · 59dde96 · 59dde96
2 parents 85ef16d + e1f3656
commit 59dde96
Show file tree

Hide file tree

Showing 70 changed files with 9,623 additions and 200 deletions.
diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html
@@ -0,0 +1,137 @@
+<!DOCTYPE HTML>
+<html lang="pt">
+<head>
+<!-- Generated by javadoc (17) on Tue Jun 11 22:51:09 BRT 2024 -->
+<title>All Classes and Interfaces (Trabalho Final LPOO)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta name="dc.created" content="2024-06-11">
+<meta name="description" content="class index">
+<meta name="generator" content="javadoc/AllClassesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="all-classes-index-page">
+<script type="text/javascript">var evenRowColor = "even-row-color";
+var oddRowColor = "odd-row-color";
+var tableTab = "table-tab";
+var activeTableTab = "active-table-tab";
+var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar-top">
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html#all-classes">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div class="nav-list-search"><label for="search-input">SEARCH:</label>
+<input type="text" id="search-input" value="search" disabled="disabled">
+<input type="reset" id="reset-button" value="reset" disabled="disabled">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<div class="header">
+<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
+</div>
+<div id="all-classes-table">
+<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button></div>
+<div id="all-classes-table.tabpanel" role="tabpanel">
+<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
+<div class="table-header col-first">Class</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/models/Cliente.html" title="class in main.br.ufpr.models">Cliente</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Esta classe representa um cliente no sistema.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/models/Conta.html" title="class in main.br.ufpr.models">Conta</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Esta é uma classe abstrata que representa uma conta no sistema.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/models/ContaCorrente.html" title="class in main.br.ufpr.models">ContaCorrente</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Esta classe representa uma Conta Corrente no sistema.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="main/br/ufpr/models/ContaI.html" title="interface in main.br.ufpr.models">ContaI</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">Esta é uma interface que define os métodos que uma conta deve implementar.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/models/ContaInvestimento.html" title="class in main.br.ufpr.models">ContaInvestimento</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Esta classe representa uma Conta de Investimento no sistema.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/models/Endereco.html" title="class in main.br.ufpr.models">Endereco</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Esta classe representa um Endereço no sistema.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/views/Home.html" title="class in main.br.ufpr.views">Home</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Esta classe representa a tela inicial do sistema.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="main/br/ufpr/controllers/Imagens.html" title="enum class in main.br.ufpr.controllers">Imagens</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
+<div class="block">Enum que contém os caminhos das imagens utilizadas no projeto</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/views/ManipularConta.html" title="class in main.br.ufpr.views">ManipularConta</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Classe que representa a tela de manipulação de conta
+ Realiza transações como saque, depósito e investimento</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/views/ManterCliente.html" title="class in main.br.ufpr.views">ManterCliente</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Esta classe representa a tela de manutenção do cliente.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/views/ManterClienteTableModel.html" title="class in main.br.ufpr.views">ManterClienteTableModel</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Esta classe é um modelo de tabela para a visualização ManterCliente.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/controllers/Mensagens.html" title="class in main.br.ufpr.controllers">Mensagens</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Classe que contém métodos para exibir mensagens de erro, aviso, sucesso e confirmação
+ Utiliza a classe JOptionPane para exibir as mensagens</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/controllers/Sistema.html" title="class in main.br.ufpr.controllers">Sistema</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Classe que controla a navegação entre as telas e o cadastro de clientes e contas
+ Age como um controlador de rotas e de dados</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="main/br/ufpr/models/Tela.html" title="interface in main.br.ufpr.models">Tela</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">Esta é uma interface que define os métodos que uma tela deve implementar.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/views/VincularCliente.html" title="class in main.br.ufpr.views">VincularCliente</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Classe responsável por vincular um cliente a uma conta.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="main/br/ufpr/views/VincularTableModel.html" title="class in main.br.ufpr.views">VincularTableModel</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Esta classe é um modelo de tabela para a visualização Vincular.</div>
+</div>
+</div>
+</div>
+</div>
+</main>
+</div>
+</div>
+</body>
+</html>
diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html
@@ -0,0 +1,68 @@
+<!DOCTYPE HTML>
+<html lang="pt">
+<head>
+<!-- Generated by javadoc (17) on Tue Jun 11 22:51:09 BRT 2024 -->
+<title>All Packages (Trabalho Final LPOO)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta name="dc.created" content="2024-06-11">
+<meta name="description" content="package index">
+<meta name="generator" content="javadoc/AllPackagesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="all-packages-index-page">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar-top">
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html#all-packages">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div class="nav-list-search"><label for="search-input">SEARCH:</label>
+<input type="text" id="search-input" value="search" disabled="disabled">
+<input type="reset" id="reset-button" value="reset" disabled="disabled">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<div class="header">
+<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
+</div>
+<div class="caption"><span>Package Summary</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Package</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color"><a href="main/br/ufpr/controllers/package-summary.html">main.br.ufpr.controllers</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="main/br/ufpr/models/package-summary.html">main.br.ufpr.models</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="main/br/ufpr/views/package-summary.html">main.br.ufpr.views</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+</div>
+</main>
+</div>
+</div>
+</body>
+</html>
diff --git a/docs/copy.svg b/docs/copy.svg
diff --git a/docs/element-list b/docs/element-list
@@ -0,0 +1,3 @@
+main.br.ufpr.controllers
+main.br.ufpr.models
+main.br.ufpr.views