Added Javadoc

marcomarrelli · Feb 18, 2024 · 7982385 · 7982385
1 parent 209da0b
commit 7982385
Show file tree

Hide file tree

Showing 78 changed files with 13,123 additions and 0 deletions.
diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html
@@ -0,0 +1,206 @@
+<!DOCTYPE HTML>
+<html lang="it">
+<head>
+<!-- Generated by javadoc (17) -->
+<title>All Classes and Interfaces (pvz-clone API)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<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></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-tab1"><a href="pvzclone/model/api/ActiveEntities.html" title="interface in pvzclone.model.api">ActiveEntities</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
+<div class="block">This interface models the methods for Zombies and Plants.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/model/api/Bullet.html" title="interface in pvzclone.model.api">Bullet</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">interface for the bullet.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/BulletImpl.html" title="class in pvzclone.model.impl">BulletImpl</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Class that implements the interface Bullet.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/controller/api/Controller.html" title="interface in pvzclone.controller.api">Controller</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">This interface models a Controller for the game.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/controller/impl/ControllerImpl.html" title="class in pvzclone.controller.impl">ControllerImpl</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Class that implements the Controller.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/model/api/Entities.html" title="interface in pvzclone.model.api">Entities</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">This interface models a generic entity.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/model/api/EntitiesFactory.html" title="interface in pvzclone.model.api">EntitiesFactory</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
+<div class="block">Factory Pattern for auomatically generated Entities, such as Zombies and Suns.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/view/impl/FieldCell.html" title="class in pvzclone.view.impl">FieldCell</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Cell used in Game Panel for placing Plants Entities.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/view/impl/FieldCellListener.html" title="class in pvzclone.view.impl">FieldCellListener</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Mouse Event Listener for the <a href="pvzclone/view/impl/FieldCell.html" title="class in pvzclone.view.impl"><code>FieldCell</code></a> Component.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/model/api/Game.html" title="interface in pvzclone.model.api">Game</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">This interface models a Game.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/GameImpl.html" title="class in pvzclone.model.impl">GameImpl</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">class that implements the interface Game.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/view/impl/GamePanel.html" title="class in pvzclone.view.impl">GamePanel</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Panel used in the Gameplay Section.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/model/api/GameState.html" title="interface in pvzclone.model.api">GameState</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
+<div class="block">This interface models a GameState.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/GameStateImpl.html" title="class in pvzclone.model.impl">GameStateImpl</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Class that implements GameState.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/view/impl/GenericPanel.html" title="class in pvzclone.view.impl">GenericPanel</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Abstract class for Panels, with a pre-setted Constructor.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/model/api/Level.html" title="interface in pvzclone.model.api">Level</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">This interface models a Level.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/LevelImpl.html" title="class in pvzclone.model.impl">LevelImpl</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Class that implements a Level.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/view/impl/LevelPanel.html" title="class in pvzclone.view.impl">LevelPanel</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Panel used to choose the level at the start of the application.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/LevelsManager.html" title="class in pvzclone.model.impl">LevelsManager</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Class used for Managing Levels in the Game.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/view/impl/MenuPanel.html" title="class in pvzclone.view.impl">MenuPanel</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Panel used in the starting Menu Section.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/Pair.html" title="class in pvzclone.model.impl">Pair</a>&lt;<a href="pvzclone/model/impl/Pair.html" title="type parameter in Pair">X</a>,<wbr><a href="pvzclone/model/impl/Pair.html" title="type parameter in Pair">Y</a>&gt;</div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">A standard generic Pair&lt;X,Y&gt;.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/model/api/Plant.html" title="interface in pvzclone.model.api">Plant</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">interface for the entity plant.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/PlantImpl.html" title="class in pvzclone.model.impl">PlantImpl</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">class that implements Plant interface.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/PvzStart.html" title="class in pvzclone">PvzStart</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Plants Vs Zombies Application's Entry Point.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/model/api/Sun.html" title="interface in pvzclone.model.api">Sun</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
+<div class="block">Interface that models a Sun Entity and provides
+ methods to interact with the entity.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/SunImpl.html" title="class in pvzclone.model.impl">SunImpl</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Implementation of the Sun interface.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/SunsFactory.html" title="class in pvzclone.model.impl">SunsFactory</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">This class contains methods to create Sun entities.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/view/impl/SwingViewImpl.html" title="class in pvzclone.view.impl">SwingViewImpl</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Implementation of the View.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/view/api/View.html" title="interface in pvzclone.view.api">View</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
+<div class="block">View Interface, gets/sets the current Scene and updates it.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/model/api/World.html" title="interface in pvzclone.model.api">World</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">Interface of the Model of the game.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/WorldImpl.html" title="class in pvzclone.model.impl">WorldImpl</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Implementation of the World Interface.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="pvzclone/model/api/Zombie.html" title="interface in pvzclone.model.api">Zombie</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">This interface models a Zombie Entity.</div>
+</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/ZombieImpl.html" title="class in pvzclone.model.impl">ZombieImpl</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Class that implements Zombie Interface.</div>
+</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="pvzclone/model/impl/ZombiesFactory.html" title="class in pvzclone.model.impl">ZombiesFactory</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Class that implements EntitiesFactory.</div>
+</div>
+</div>
+</div>
+</div>
+</main>
+</div>
+</div>
+</body>
+</html>
diff --git a/javadoc/allpackages-index.html b/javadoc/allpackages-index.html
@@ -0,0 +1,75 @@
+<!DOCTYPE HTML>
+<html lang="it">
+<head>
+<!-- Generated by javadoc (17) -->
+<title>All Packages (pvz-clone API)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<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="pvzclone/package-summary.html">pvzclone</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="pvzclone/controller/api/package-summary.html">pvzclone.controller.api</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="pvzclone/controller/impl/package-summary.html">pvzclone.controller.impl</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="pvzclone/model/api/package-summary.html">pvzclone.model.api</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="pvzclone/model/impl/package-summary.html">pvzclone.model.impl</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><a href="pvzclone/view/api/package-summary.html">pvzclone.view.api</a></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><a href="pvzclone/view/impl/package-summary.html">pvzclone.view.impl</a></div>
+<div class="col-last even-row-color">&nbsp;</div>
+</div>
+</main>
+</div>
+</div>
+</body>
+</html>