Skip to content

Commit

Permalink
added first UML and JavaDoc
Browse files Browse the repository at this point in the history 
worked on the documentation and created the first UML-Diagram as
streetlife.png
  • Loading branch information
@Dachgruber
Dachgruber committed Feb 1, 2022
1 parent 353a5ed commit 7409bb1
Show file tree
Hide file tree
Showing 120 changed files with 60,291 additions and 1 deletion.
1 change: 0 additions & 1 deletion streetlife/.gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/bin/
/doc/
/.settings/
/target/
284 changes: 284 additions & 0 deletions streetlife/doc/allclasses-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,284 @@
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Tue Feb 01 16:32:48 CET 2022 -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-02-01">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/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>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="jquery/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":2,"i2":2,"i3":1,"i4":2,"i5":2,"i6":2,"i7":2,"i8":2,"i9":1,"i10":2,"i11":2,"i12":2,"i13":2,"i14":2,"i15":2,"i16":2,"i17":2,"i18":2,"i19":2,"i20":2,"i21":1};
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">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</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>
<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">
<!-- -->
</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>
<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>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/model/Car.html" title="class in infpp.streetlife.model">Car</a></td>
<th class="colLast" scope="row">
<div class="block">Class for cars.</div>
</th>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/view/CloseDialog.html" title="class in infpp.streetlife.view">CloseDialog</a></td>
<th class="colLast" scope="row">
<div class="block">The CloseDialog is a custom PopUp window that asks the user, if he/she really wants to close the application.</div>
</th>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/view/ComboBoxRenderer.html" title="class in infpp.streetlife.view">ComboBoxRenderer</a></td>
<th class="colLast" scope="row">
<div class="block">ComboBoxRenderer are a custom CellRenderer for JComboBoxes used for StreetObjects.</div>
</th>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/controller/Controller.html" title="interface in infpp.streetlife.controller">Controller</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/view/ErrorDialog.html" title="class in infpp.streetlife.view">ErrorDialog</a></td>
<th class="colLast" scope="row">
<div class="block">The ErrorDialog is a custom PopUp window that notifies the user after encountering an error.</div>
</th>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/FileLoader.html" title="class in infpp.streetlife">FileLoader</a></td>
<th class="colLast" scope="row">
<div class="block">The FileLoader does exactly what the name suggest: loading files.</div>
</th>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/model/Frog.html" title="class in infpp.streetlife.model">Frog</a></td>
<th class="colLast" scope="row">
<div class="block">Class for frogs.</div>
</th>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/view/HelpDialog.html" title="class in infpp.streetlife.view">HelpDialog</a></td>
<th class="colLast" scope="row">
<div class="block">The HelpDialog is a custom PopUp window that tells the user some "helpful" information.</div>
</th>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/model/Lane.html" title="class in infpp.streetlife.model">Lane</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/model/Model.html" title="interface in infpp.streetlife.model">Model</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/model/MovingStreetObject.html" title="class in infpp.streetlife.model">MovingStreetObject</a></td>
<th class="colLast" scope="row">
<div class="block">Class for moving Street Objects.</div>
</th>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/view/StartUpDialog.html" title="class in infpp.streetlife.view">StartUpDialog</a></td>
<th class="colLast" scope="row">
<div class="block">The StartUpDialog is the first thing the user interacts with.</div>
</th>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/view/StreetGUI.html" title="class in infpp.streetlife.view">StreetGUI</a></td>
<th class="colLast" scope="row">
<div class="block">The StreetGUI represents the graphical interface of the street with the display area, control buttons, menu bar etc.</div>
</th>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/controller/StreetLifeController.html" title="class in infpp.streetlife.controller">StreetLifeController</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/StreetLifeMain.html" title="class in infpp.streetlife">StreetLifeMain</a></td>
<th class="colLast" scope="row">
<div class="block">Class for starting the StreetLifeController</div>
</th>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/model/StreetLifeModel.html" title="class in infpp.streetlife.model">StreetLifeModel</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/view/StreetLifeView.html" title="class in infpp.streetlife.view">StreetLifeView</a></td>
<th class="colLast" scope="row">
<div class="block">The StreetLifeView implements the interface, manages the in/outputs and controls the gui.</div>
</th>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/model/StreetObject.html" title="class in infpp.streetlife.model">StreetObject</a></td>
<th class="colLast" scope="row">
<div class="block">abstract class for objects on the street.</div>
</th>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/controller/StreetThread.html" title="class in infpp.streetlife.controller">StreetThread</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/view/TexturePanel.html" title="class in infpp.streetlife.view">TexturePanel</a></td>
<th class="colLast" scope="row">
<div class="block">Class TexturePanel to create a custom swing JPanel for displaying resizable pictures.</div>
</th>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><a href="infpp/streetlife/view/TextView.html" title="class in infpp.streetlife.view">TextView</a></td>
<th class="colLast" scope="row">
<div class="block">Simple text display on the system console, could be used for debug if gui gets bricked</div>
</th>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><a href="infpp/streetlife/view/View.html" title="interface in infpp.streetlife.view">View</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-files/index-1.html">Index</a></li>
<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>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
49 changes: 49 additions & 0 deletions streetlife/doc/allclasses.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Tue Feb 01 16:32:48 CET 2022 -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-02-01">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/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>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<main role="main" class="indexContainer">
<ul>
<li><a href="infpp/streetlife/model/Car.html" title="class in infpp.streetlife.model">Car</a></li>
<li><a href="infpp/streetlife/view/CloseDialog.html" title="class in infpp.streetlife.view">CloseDialog</a></li>
<li><a href="infpp/streetlife/view/ComboBoxRenderer.html" title="class in infpp.streetlife.view">ComboBoxRenderer</a></li>
<li><a href="infpp/streetlife/controller/Controller.html" title="interface in infpp.streetlife.controller"><span class="interfaceName">Controller</span></a></li>
<li><a href="infpp/streetlife/view/ErrorDialog.html" title="class in infpp.streetlife.view">ErrorDialog</a></li>
<li><a href="infpp/streetlife/FileLoader.html" title="class in infpp.streetlife">FileLoader</a></li>
<li><a href="infpp/streetlife/model/Frog.html" title="class in infpp.streetlife.model">Frog</a></li>
<li><a href="infpp/streetlife/view/HelpDialog.html" title="class in infpp.streetlife.view">HelpDialog</a></li>
<li><a href="infpp/streetlife/model/Lane.html" title="class in infpp.streetlife.model">Lane</a></li>
<li><a href="infpp/streetlife/model/Model.html" title="interface in infpp.streetlife.model"><span class="interfaceName">Model</span></a></li>
<li><a href="infpp/streetlife/model/MovingStreetObject.html" title="class in infpp.streetlife.model">MovingStreetObject</a></li>
<li><a href="infpp/streetlife/view/StartUpDialog.html" title="class in infpp.streetlife.view">StartUpDialog</a></li>
<li><a href="infpp/streetlife/view/StreetGUI.html" title="class in infpp.streetlife.view">StreetGUI</a></li>
<li><a href="infpp/streetlife/controller/StreetLifeController.html" title="class in infpp.streetlife.controller">StreetLifeController</a></li>
<li><a href="infpp/streetlife/StreetLifeMain.html" title="class in infpp.streetlife">StreetLifeMain</a></li>
<li><a href="infpp/streetlife/model/StreetLifeModel.html" title="class in infpp.streetlife.model">StreetLifeModel</a></li>
<li><a href="infpp/streetlife/view/StreetLifeView.html" title="class in infpp.streetlife.view">StreetLifeView</a></li>
<li><a href="infpp/streetlife/model/StreetObject.html" title="class in infpp.streetlife.model">StreetObject</a></li>
<li><a href="infpp/streetlife/controller/StreetThread.html" title="class in infpp.streetlife.controller">StreetThread</a></li>
<li><a href="infpp/streetlife/view/TexturePanel.html" title="class in infpp.streetlife.view">TexturePanel</a></li>
<li><a href="infpp/streetlife/view/TextView.html" title="class in infpp.streetlife.view">TextView</a></li>
<li><a href="infpp/streetlife/view/View.html" title="interface in infpp.streetlife.view"><span class="interfaceName">View</span></a></li>
</ul>
</main>
</body>
</html>
Loading

0 comments on commit 7409bb1

Please sign in to comment.