javadoc test

lincolncpp · Jun 17, 2020 · 2adfea1 · 2adfea1
1 parent 5a1d5e5
commit 2adfea1
Show file tree

Hide file tree

Showing 24 changed files with 86 additions and 100 deletions.
diff --git a/Makefile b/Makefile
@@ -1,7 +1,8 @@
 PACKAGE=com.usp.corrida
 DEST=docs/
 SRC=core/src/
+TITLE="Corrida Aritmetica - docs"
 
 doc:
 	rm -rf docs/
-	javadoc -noindex -notree -nohelp -nodeprecated -d $(DEST) -sourcepath $(SRC) $(PACKAGE) $(PACKAGE).logic $(PACKAGE).screens $(PACKAGE).utils
+	javadoc -doctitle $(TITLE) -windowtitle $(TITLE) -noindex -notree -nohelp -nodeprecated -d $(DEST) -sourcepath $(SRC) $(PACKAGE) $(PACKAGE).logic $(PACKAGE).screens $(PACKAGE).utils
diff --git a/core/src/com/usp/corrida/Core.java b/core/src/com/usp/corrida/Core.java
@@ -12,13 +12,10 @@
 import com.usp.corrida.utils.Random;
 
 /**
- * Lorem ipsum dolor sit amet
+ * Classe principal do jogo.
  */
 public class Core extends com.badlogic.gdx.Game {
 
-	/**
-	 * Variable description
-	 */
 	public float width;
 	public float height;
 
@@ -44,6 +41,9 @@ public class Core extends com.badlogic.gdx.Game {
 	// Debug
 	Boolean showFPS = false;
 
+	/**
+	 * Faz as primeiras configurações do programa.
+	 */
 	@Override
 	public void create () {
 		// Camera building
@@ -70,6 +70,9 @@ public void create () {
 		setScreen(titleScreen);
 	}
 
+	/**
+	 * Cuida de toda a renderização do jogo.
+	 */
 	@Override
 	public void render () {
 		Gdx.gl.glClearColor(69/255f, 186/255f, 230/255f, 1);
@@ -90,7 +93,10 @@ public void render () {
 
 		batch.end();
 	}
-
+
+	/**
+	 * Descarrega todos os recursos.
+	 */
 	@Override
 	public void dispose () {
 		batch.dispose();

diff --git a/core/src/test/java/com/usp/corrida/GameTest.java b/core/src/test/java/com/usp/corrida/GameTest.java
diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>All Classes</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>All Classes (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>

diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>All Classes</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>All Classes (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>

diff --git a/docs/com/usp/corrida/Core.html b/docs/com/usp/corrida/Core.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>Core</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>Core (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
@@ -12,7 +12,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Core";
+            parent.document.title="Core (Corrida Aritmetica - docs)";
         }
     }
     catch(err) {
@@ -111,7 +111,7 @@ <h2 title="Class Core" class="title">Class Core</h2>
 <br>
 <pre>public class <span class="typeNameLabel">Core</span>
 extends com.badlogic.gdx.Game</pre>
-<div class="block">Lorem ipsum dolor sit amet</div>
+<div class="block">Classe principal do jogo.</div>
 </li>
 </ul>
 </div>
@@ -160,9 +160,7 @@ <h3>Field Summary</h3>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>float</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/usp/corrida/Core.html#width">width</a></span></code>
-<div class="block">Variable description</div>
-</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/usp/corrida/Core.html#width">width</a></span></code>&nbsp;</td>
 </tr>
 </table>
 </li>
@@ -198,15 +196,21 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/usp/corrida/Core.html#create--">create</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/usp/corrida/Core.html#create--">create</a></span>()</code>
+<div class="block">Faz as primeiras configurações do programa.</div>
+</td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/usp/corrida/Core.html#dispose--">dispose</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/usp/corrida/Core.html#dispose--">dispose</a></span>()</code>
+<div class="block">Descarrega todos os recursos.</div>
+</td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/usp/corrida/Core.html#render--">render</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/usp/corrida/Core.html#render--">render</a></span>()</code>
+<div class="block">Cuida de toda a renderização do jogo.</div>
+</td>
 </tr>
 </table>
 <ul class="blockList">
@@ -300,7 +304,6 @@ <h4>titleScreen</h4>
 <li class="blockList">
 <h4>width</h4>
 <pre>public&nbsp;float width</pre>
-<div class="block">Variable description</div>
 </li>
 </ul>
 </li>
@@ -335,6 +338,7 @@ <h3>Method Detail</h3>
 <li class="blockList">
 <h4>create</h4>
 <pre>public&nbsp;void&nbsp;create()</pre>
+<div class="block">Faz as primeiras configurações do programa.</div>
 </li>
 </ul>
 <a name="dispose--">
@@ -344,6 +348,7 @@ <h4>create</h4>
 <li class="blockList">
 <h4>dispose</h4>
 <pre>public&nbsp;void&nbsp;dispose()</pre>
+<div class="block">Descarrega todos os recursos.</div>
 </li>
 </ul>
 <a name="render--">
@@ -353,6 +358,7 @@ <h4>dispose</h4>
 <li class="blockList">
 <h4>render</h4>
 <pre>public&nbsp;void&nbsp;render()</pre>
+<div class="block">Cuida de toda a renderização do jogo.</div>
 </li>
 </ul>
 </li>

diff --git a/docs/com/usp/corrida/logic/Character.html b/docs/com/usp/corrida/logic/Character.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>Character</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>Character (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
@@ -12,7 +12,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Character";
+            parent.document.title="Character (Corrida Aritmetica - docs)";
         }
     }
     catch(err) {

diff --git a/docs/com/usp/corrida/logic/Game.html b/docs/com/usp/corrida/logic/Game.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>Game</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>Game (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
@@ -12,7 +12,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Game";
+            parent.document.title="Game (Corrida Aritmetica - docs)";
         }
     }
     catch(err) {

diff --git a/docs/com/usp/corrida/logic/package-frame.html b/docs/com/usp/corrida/logic/package-frame.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>com.usp.corrida.logic</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>com.usp.corrida.logic (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>

diff --git a/docs/com/usp/corrida/logic/package-summary.html b/docs/com/usp/corrida/logic/package-summary.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>com.usp.corrida.logic</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>com.usp.corrida.logic (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
@@ -12,7 +12,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="com.usp.corrida.logic";
+            parent.document.title="com.usp.corrida.logic (Corrida Aritmetica - docs)";
         }
     }
     catch(err) {

diff --git a/docs/com/usp/corrida/package-frame.html b/docs/com/usp/corrida/package-frame.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>com.usp.corrida</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>com.usp.corrida (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>

diff --git a/docs/com/usp/corrida/package-summary.html b/docs/com/usp/corrida/package-summary.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>com.usp.corrida</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>com.usp.corrida (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
@@ -12,7 +12,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="com.usp.corrida";
+            parent.document.title="com.usp.corrida (Corrida Aritmetica - docs)";
         }
     }
     catch(err) {
@@ -80,7 +80,7 @@ <h1 title="Package" class="title">Package&nbsp;com.usp.corrida</h1>
 <tr class="altColor">
 <td class="colFirst"><a href="../../../com/usp/corrida/Core.html" title="class in com.usp.corrida">Core</a></td>
 <td class="colLast">
-<div class="block">Lorem ipsum dolor sit amet</div>
+<div class="block">Classe principal do jogo.</div>
 </td>
 </tr>
 </tbody>

diff --git a/docs/com/usp/corrida/screens/GameScreen.html b/docs/com/usp/corrida/screens/GameScreen.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>GameScreen</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>GameScreen (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
@@ -12,7 +12,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="GameScreen";
+            parent.document.title="GameScreen (Corrida Aritmetica - docs)";
         }
     }
     catch(err) {

diff --git a/docs/com/usp/corrida/screens/TitleScreen.html b/docs/com/usp/corrida/screens/TitleScreen.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>TitleScreen</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>TitleScreen (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
@@ -12,7 +12,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="TitleScreen";
+            parent.document.title="TitleScreen (Corrida Aritmetica - docs)";
         }
     }
     catch(err) {

diff --git a/docs/com/usp/corrida/screens/package-frame.html b/docs/com/usp/corrida/screens/package-frame.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>com.usp.corrida.screens</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>com.usp.corrida.screens (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>

diff --git a/docs/com/usp/corrida/screens/package-summary.html b/docs/com/usp/corrida/screens/package-summary.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:36:51 BRT 2020 -->
-<title>com.usp.corrida.screens</title>
+<!-- Generated by javadoc (1.8.0_252) on Tue Jun 16 21:57:07 BRT 2020 -->
+<title>com.usp.corrida.screens (Corrida Aritmetica - docs)</title>
 <meta name="date" content="2020-06-16">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
@@ -12,7 +12,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="com.usp.corrida.screens";
+            parent.document.title="com.usp.corrida.screens (Corrida Aritmetica - docs)";
         }
     }
     catch(err) {