Skip to content

Commit

Permalink
Updating Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@jrmmba8314
jrmmba8314 committed Jul 23, 2020
1 parent 1268a71 commit 63087dd
Show file tree
Hide file tree
Showing 348 changed files with 85,797 additions and 28,815 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ The table layout is as follows

Two different applications exist

- usermodel_initial - This is the initial application to which we will add the "bells and whistles" related to exception handling, custom swagger documentation, and accessing other API's data.
- usermodel - the finished version with many "bells and whistles" added. Note that a few additions to the application seem "forced" or out of place. These are done specifically to show how to use certain commands!
- usermodel-exceptions-initial - This is the initial application to which we will add the "bells and whistles" related to exception handling, custom swagger documentation, and accessing other API's data.
- usermodel-exceptions - the finished version with many "bells and whistles" added. Note that a few additions to the application seem "forced" or out of place. These are done specifically to show how to use certain commands!
0 usermodel-initial/.gitignore → usermodel-exceptions-initial/.gitignore
View file
File renamed without changes.
0 .../.mvn/wrapper/MavenWrapperDownloader.java → .../.mvn/wrapper/MavenWrapperDownloader.java
View file
File renamed without changes.
0 ...el-initial/.mvn/wrapper/maven-wrapper.jar → ...ns-initial/.mvn/wrapper/maven-wrapper.jar
View file
File renamed without changes.
0 ...ial/.mvn/wrapper/maven-wrapper.properties → ...ial/.mvn/wrapper/maven-wrapper.properties
View file
File renamed without changes.
1,054 changes: 1,054 additions & 0 deletions usermodel-exceptions-initial/README.md
View file

Large diffs are not rendered by default.

177 changes: 60 additions & 117 deletions ...el-initial/javadocs/allclasses-index.html → ...ns-initial/javadocs/allclasses-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,38 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.5) on Tue Mar 24 18:37:33 PDT 2020 -->
<!-- Generated by javadoc (14.0.1) on Wed Jul 22 20:44:39 PDT 2020 -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2020-03-24">
<meta name="dc.created" content="2020-07-22">
<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="jquery/jquery-ui.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<script type="text/javascript" src="script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="All Classes";
}
}
catch(err) {
}
//-->
var data = {"i0":2,"i1":1,"i2":2,"i3":1,"i4":2,"i5":1,"i6":2,"i7":2,"i8":2,"i9":2,"i10":2,"i11":2,"i12":2,"i13":2,"i14":1,"i15":1,"i16":2,"i17":2,"i18":2,"i19":1,"i20":1,"i21":2,"i22":1,"i23":2};
<body class="all-classes-index">
<script type="text/javascript">var data = {"i0":2,"i1":2,"i2":1,"i3":2,"i4":1,"i5":2,"i6":2,"i7":2,"i8":2,"i9":2,"i10":2,"i11":2,"i12":2,"i13":1,"i14":1,"i15":2,"i16":2,"i17":1,"i18":2,"i19":2,"i20":1,"i21":2};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "./";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
Expand All @@ -61,203 +53,171 @@
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<div class="flexContent">
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</div>
<div class="allClassesContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span id="t0" class="activeTableTab"><span>All Classes</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Interface Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<div class="typeSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="typeSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Classes</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Interface Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Class Summary</button></div>
<div id="typeSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><a href="com/lambdaschool/usermodel/config/H2ServerConfiguration.html" title="class in com.lambdaschool.usermodel.config">H2ServerConfiguration</a></td>
<th class="colLast" scope="row">
<div class="block">Configures H2 access through the JetBrains IntelliJ IDEA IDE.</div>
</th>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><a href="com/lambdaschool/usermodel/views/JustTheCount.html" title="interface in com.lambdaschool.usermodel.views">JustTheCount</a></td>
<th class="colLast" scope="row">
<div class="block">Used when a custom query is to just count how many of something are in the table</div>
</th>
</tr>
<tr id="i2" class="altColor">
<tr class="rowColor" id="i1">
<td class="colFirst"><a href="com/lambdaschool/usermodel/models/Role.html" title="class in com.lambdaschool.usermodel.models">Role</a></td>
<th class="colLast" scope="row">
<div class="block">The entity allowing interaction with the roles table.</div>
</th>
</tr>
<tr id="i3" class="rowColor">
<tr class="altColor" id="i2">
<td class="colFirst"><a href="com/lambdaschool/usermodel/repository/RoleRepository.html" title="interface in com.lambdaschool.usermodel.repository">RoleRepository</a></td>
<th class="colLast" scope="row">
<div class="block">The CRUD Repository connecting Role to the rest of the application</div>
</th>
</tr>
<tr id="i4" class="altColor">
<tr class="rowColor" id="i3">
<td class="colFirst"><a href="com/lambdaschool/usermodel/controllers/RolesController.html" title="class in com.lambdaschool.usermodel.controllers">RolesController</a></td>
<th class="colLast" scope="row">
<div class="block">The entry point for clients to access role data</div>
</th>
</tr>
<tr id="i5" class="rowColor">
<tr class="altColor" id="i4">
<td class="colFirst"><a href="com/lambdaschool/usermodel/services/RoleService.html" title="interface in com.lambdaschool.usermodel.services">RoleService</a></td>
<th class="colLast" scope="row">
<div class="block">The service that works with the Role Model.</div>
</th>
</tr>
<tr id="i6" class="altColor">
<tr class="rowColor" id="i5">
<td class="colFirst"><a href="com/lambdaschool/usermodel/services/RoleServiceImpl.html" title="class in com.lambdaschool.usermodel.services">RoleServiceImpl</a></td>
<th class="colLast" scope="row">
<div class="block">Implements the RoleService Interface</div>
</th>
</tr>
<tr id="i7" class="rowColor">
<tr class="altColor" id="i6">
<td class="colFirst"><a href="com/lambdaschool/usermodel/SeedData.html" title="class in com.lambdaschool.usermodel">SeedData</a></td>
<th class="colLast" scope="row">
<div class="block">SeedData puts both known and random data into the database.</div>
</th>
</tr>
<tr id="i8" class="altColor">
<tr class="rowColor" id="i7">
<td class="colFirst"><a href="com/lambdaschool/usermodel/config/Swagger2Config.html" title="class in com.lambdaschool.usermodel.config">Swagger2Config</a></td>
<th class="colLast" scope="row">
<div class="block">Configures the default Swagger Documentation</div>
</th>
</tr>
<tr id="i9" class="rowColor">
<tr class="altColor" id="i8">
<td class="colFirst"><a href="com/lambdaschool/usermodel/models/User.html" title="class in com.lambdaschool.usermodel.models">User</a></td>
<th class="colLast" scope="row">
<div class="block">The entity allowing interaction with the users table</div>
</th>
</tr>
<tr id="i10" class="altColor">
<tr class="rowColor" id="i9">
<td class="colFirst"><a href="com/lambdaschool/usermodel/services/UserAuditing.html" title="class in com.lambdaschool.usermodel.services">UserAuditing</a></td>
<th class="colLast" scope="row">
<div class="block">Spring Boot needs to know what username to use for the auditing fields CreatedBy and ModifiedBy
For now, a default name will be used</div>
</th>
</tr>
<tr id="i11" class="rowColor">
<tr class="altColor" id="i10">
<td class="colFirst"><a href="com/lambdaschool/usermodel/controllers/UserController.html" title="class in com.lambdaschool.usermodel.controllers">UserController</a></td>
<th class="colLast" scope="row">
<div class="block">The entry point for clients to access user data</div>
</th>
</tr>
<tr id="i12" class="altColor">
<tr class="rowColor" id="i11">
<td class="colFirst"><a href="com/lambdaschool/usermodel/models/Useremail.html" title="class in com.lambdaschool.usermodel.models">Useremail</a></td>
<th class="colLast" scope="row">
<div class="block">The entity allowing interaction with the useremails table</div>
</th>
</tr>
<tr id="i13" class="rowColor">
<tr class="altColor" id="i12">
<td class="colFirst"><a href="com/lambdaschool/usermodel/controllers/UseremailController.html" title="class in com.lambdaschool.usermodel.controllers">UseremailController</a></td>
<th class="colLast" scope="row">
<div class="block">The entry point for client to access user, email combinations</div>
</th>
</tr>
<tr id="i14" class="altColor">
<tr class="rowColor" id="i13">
<td class="colFirst"><a href="com/lambdaschool/usermodel/repository/UseremailRepository.html" title="interface in com.lambdaschool.usermodel.repository">UseremailRepository</a></td>
<th class="colLast" scope="row">
<div class="block">The CRUD Repository connecting Useremail to the rest of the application</div>
</th>
</tr>
<tr id="i15" class="rowColor">
<tr class="altColor" id="i14">
<td class="colFirst"><a href="com/lambdaschool/usermodel/services/UseremailService.html" title="interface in com.lambdaschool.usermodel.services">UseremailService</a></td>
<th class="colLast" scope="row">
<div class="block">The Service that works with the Useremail Model</div>
</th>
</tr>
<tr id="i16" class="altColor">
<tr class="rowColor" id="i15">
<td class="colFirst"><a href="com/lambdaschool/usermodel/services/UseremailServiceImpl.html" title="class in com.lambdaschool.usermodel.services">UseremailServiceImpl</a></td>
<th class="colLast" scope="row">
<div class="block">Implements the UseremailService Interface</div>
</th>
</tr>
<tr id="i17" class="rowColor">
<tr class="altColor" id="i16">
<td class="colFirst"><a href="com/lambdaschool/usermodel/UserModelApplication.html" title="class in com.lambdaschool.usermodel">UserModelApplication</a></td>
<th class="colLast" scope="row">
<div class="block">Main class to start the application.</div>
</th>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><a href="com/lambdaschool/usermodel/UserModelApplicationTests.html" title="class in com.lambdaschool.usermodel">UserModelApplicationTests</a></td>
<th class="colLast" scope="row">
<div class="block">Starting class for testing</div>
</th>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><a href="com/lambdaschool/usermodel/views/UserNameCountEmails.html" title="interface in com.lambdaschool.usermodel.views">UserNameCountEmails</a></td>
<th class="colLast" scope="row">
<div class="block">Used to format the JSON output for a custom query that gathers information on username and the count of how many emails they have</div>
</th>
</tr>
<tr id="i20" class="altColor">
<tr class="rowColor" id="i17">
<td class="colFirst"><a href="com/lambdaschool/usermodel/repository/UserRepository.html" title="interface in com.lambdaschool.usermodel.repository">UserRepository</a></td>
<th class="colLast" scope="row">
<div class="block">The CRUD repository connecting User to the rest of the application</div>
</th>
</tr>
<tr id="i21" class="rowColor">
<tr class="altColor" id="i18">
<td class="colFirst"><a href="com/lambdaschool/usermodel/models/UserRoles.html" title="class in com.lambdaschool.usermodel.models">UserRoles</a></td>
<th class="colLast" scope="row">
<div class="block">The entity allowing interaction with the userroles table.</div>
</th>
</tr>
<tr id="i22" class="altColor">
<tr class="rowColor" id="i19">
<td class="colFirst"><a href="com/lambdaschool/usermodel/models/UserRolesId.html" title="class in com.lambdaschool.usermodel.models">UserRolesId</a></td>
<th class="colLast" scope="row">
<div class="block">Class to represent the complex primary key for UserRoles</div>
</th>
</tr>
<tr class="altColor" id="i20">
<td class="colFirst"><a href="com/lambdaschool/usermodel/services/UserService.html" title="interface in com.lambdaschool.usermodel.services">UserService</a></td>
<th class="colLast" scope="row">
<div class="block">The Service that works with User Model.</div>
</th>
</tr>
<tr id="i23" class="rowColor">
<tr class="rowColor" id="i21">
<td class="colFirst"><a href="com/lambdaschool/usermodel/services/UserServiceImpl.html" title="class in com.lambdaschool.usermodel.services">UserServiceImpl</a></td>
<th class="colLast" scope="row">
<div class="block">Implements the Userservice Interface</div>
<div class="block">Implements UserService Interface</div>
</th>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</div>
</div>
</main>
<footer role="contentinfo">
Expand All @@ -280,30 +240,13 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</div>
</div>
</body>
</html>
Loading

0 comments on commit 63087dd

Please sign in to comment.