Skip to content

Commit

Permalink
code documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Fernando Lincoln committed Jun 19, 2020
1 parent 47b652d commit 465f080
Show file tree
Hide file tree
Showing 28 changed files with 38 additions and 38 deletions.
2 changes: 1 addition & 1 deletion core/src/com/usp/corrida/Resources.java
View file
Expand Up @@ -5,7 +5,7 @@
import com.badlogic.gdx.graphics.g2d.BitmapFont;

/**
* A classe Resources cuida de todos os recursos compartilhados, permitindo seu uso em mais de um objeto
* Cuida de todos os recursos compartilhados, permitindo seu uso em mais de um objeto
*/
public class Resources {
public static final int MAX_SPRITES = 11;
Expand Down
2 changes: 1 addition & 1 deletion core/src/com/usp/corrida/logic/Background.java
View file
Expand Up @@ -8,7 +8,7 @@
import com.usp.corrida.utils.Utils;

/**
* A classe Background é usado para renderizar todo o cenário de fundo do jogo. Basta chamar a função render no ciclo de renderização.
* Renderiza todo o cenário de fundo do jogo. Basta chamar a função render no ciclo de renderização.
*/
public class Background {
public static final int MAX_CLOUD = 5;
Expand Down
2 changes: 1 addition & 1 deletion core/src/com/usp/corrida/logic/Character.java
View file
Expand Up @@ -7,7 +7,7 @@
import com.usp.corrida.utils.Utils;

/**
* A classe Character controla tudo relacionado ao personagem: renderização, posição, animação, toque e caixa de diálogo.
* Controla tudo relacionado ao personagem: renderização, posição, animação, toque e caixa de diálogo.
*/
public class Character {
public static final long BASE_FRAME_INTERVAL = 120;
Expand Down
2 changes: 1 addition & 1 deletion core/src/com/usp/corrida/screens/GameScreen.java
View file
Expand Up @@ -10,7 +10,7 @@
import com.usp.corrida.utils.Utils;

/**
* É a tela que lida com a renderização e mecânica de jogo. Para alternar entre telas, use a função setScreen da classe Game, passando como parâmetro o objeto da tela.
* Lida com a renderização e mecânica de jogo. Para alternar entre telas, use a função setScreen da classe Game, passando como parâmetro o objeto da tela.
*/
public class GameScreen extends ScreenAdapter {
public static final long POINTS_EFFECT_INTERVAL = 65;
Expand Down
2 changes: 1 addition & 1 deletion core/src/com/usp/corrida/screens/TitleScreen.java
View file
Expand Up @@ -8,7 +8,7 @@
import com.usp.corrida.logic.Character;

/**
* É a tela que renderiza a parte inicial do jogo. Para alternar entre telas, use a função setScreen da classe Game, passando como parâmetro o objeto da tela.
* Renderiza a parte inicial do jogo. Para alternar entre telas, use a função setScreen da classe Game, passando como parâmetro o objeto da tela.
*/
public class TitleScreen extends ScreenAdapter {
private final Core core;
Expand Down
2 changes: 1 addition & 1 deletion docs/allclasses-frame.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>All Classes (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion docs/allclasses-noframe.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>All Classes (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion docs/com/usp/corrida/Core.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Core (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions docs/com/usp/corrida/Resources.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Resources (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
Expand Down Expand Up @@ -106,7 +106,7 @@ <h2 title="Class Resources" class="title">Class Resources</h2>
<br>
<pre>public class <span class="typeNameLabel">Resources</span>
extends java.lang.Object</pre>
<div class="block">A classe Resources cuida de todos os recursos compartilhados, permitindo seu uso em mais de um objeto</div>
<div class="block">Cuida de todos os recursos compartilhados, permitindo seu uso em mais de um objeto</div>
</li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/com/usp/corrida/logic/Background.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Background (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down Expand Up @@ -106,7 +106,7 @@ <h2 title="Class Background" class="title">Class Background</h2>
<br>
<pre>public class <span class="typeNameLabel">Background</span>
extends java.lang.Object</pre>
<div class="block">A classe Background é usado para renderizar todo o cenário de fundo do jogo. Basta chamar a função render no ciclo de renderização.</div>
<div class="block">Renderiza todo o cenário de fundo do jogo. Basta chamar a função render no ciclo de renderização.</div>
</li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/com/usp/corrida/logic/Character.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Character (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down Expand Up @@ -106,7 +106,7 @@ <h2 title="Class Character" class="title">Class Character</h2>
<br>
<pre>public class <span class="typeNameLabel">Character</span>
extends java.lang.Object</pre>
<div class="block">A classe Character controla tudo relacionado ao personagem: renderização, posição, animação, toque e caixa de diálogo.</div>
<div class="block">Controla tudo relacionado ao personagem: renderização, posição, animação, toque e caixa de diálogo.</div>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/com/usp/corrida/logic/package-frame.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>com.usp.corrida.logic (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
6 changes: 3 additions & 3 deletions docs/com/usp/corrida/logic/package-summary.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>com.usp.corrida.logic (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down Expand Up @@ -80,13 +80,13 @@ <h1 title="Package" class="title">Package&nbsp;com.usp.corrida.logic</h1>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/usp/corrida/logic/Background.html" title="class in com.usp.corrida.logic">Background</a></td>
<td class="colLast">
<div class="block">A classe Background é usado para renderizar todo o cenário de fundo do jogo.</div>
<div class="block">Renderiza todo o cenário de fundo do jogo.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/usp/corrida/logic/Character.html" title="class in com.usp.corrida.logic">Character</a></td>
<td class="colLast">
<div class="block">A classe Character controla tudo relacionado ao personagem: renderização, posição, animação, toque e caixa de diálogo.</div>
<div class="block">Controla tudo relacionado ao personagem: renderização, posição, animação, toque e caixa de diálogo.</div>
</td>
</tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/com/usp/corrida/package-frame.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>com.usp.corrida (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions docs/com/usp/corrida/package-summary.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>com.usp.corrida (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
Expand Down Expand Up @@ -86,7 +86,7 @@ <h1 title="Package" class="title">Package&nbsp;com.usp.corrida</h1>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/usp/corrida/Resources.html" title="class in com.usp.corrida">Resources</a></td>
<td class="colLast">
<div class="block">A classe Resources cuida de todos os recursos compartilhados, permitindo seu uso em mais de um objeto</div>
<div class="block">Cuida de todos os recursos compartilhados, permitindo seu uso em mais de um objeto</div>
</td>
</tr>
</tbody>
Expand Down
4 changes: 2 additions & 2 deletions docs/com/usp/corrida/screens/GameScreen.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>GameScreen (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down Expand Up @@ -111,7 +111,7 @@ <h2 title="Class GameScreen" class="title">Class GameScreen</h2>
<br>
<pre>public class <span class="typeNameLabel">GameScreen</span>
extends ScreenAdapter</pre>
<div class="block">É a tela que lida com a renderização e mecânica de jogo. Para alternar entre telas, use a função setScreen da classe Game, passando como parâmetro o objeto da tela.</div>
<div class="block">Lida com a renderização e mecânica de jogo. Para alternar entre telas, use a função setScreen da classe Game, passando como parâmetro o objeto da tela.</div>
</li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/com/usp/corrida/screens/TitleScreen.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>TitleScreen (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down Expand Up @@ -111,7 +111,7 @@ <h2 title="Class TitleScreen" class="title">Class TitleScreen</h2>
<br>
<pre>public class <span class="typeNameLabel">TitleScreen</span>
extends ScreenAdapter</pre>
<div class="block">É a tela que renderiza a parte inicial do jogo. Para alternar entre telas, use a função setScreen da classe Game, passando como parâmetro o objeto da tela.</div>
<div class="block">Renderiza a parte inicial do jogo. Para alternar entre telas, use a função setScreen da classe Game, passando como parâmetro o objeto da tela.</div>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/com/usp/corrida/screens/package-frame.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>com.usp.corrida.screens (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
6 changes: 3 additions & 3 deletions docs/com/usp/corrida/screens/package-summary.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>com.usp.corrida.screens (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down Expand Up @@ -80,13 +80,13 @@ <h1 title="Package" class="title">Package&nbsp;com.usp.corrida.screens</h1>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/usp/corrida/screens/GameScreen.html" title="class in com.usp.corrida.screens">GameScreen</a></td>
<td class="colLast">
<div class="block">É a tela que lida com a renderização e mecânica de jogo.</div>
<div class="block">Lida com a renderização e mecânica de jogo.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/usp/corrida/screens/TitleScreen.html" title="class in com.usp.corrida.screens">TitleScreen</a></td>
<td class="colLast">
<div class="block">É a tela que renderiza a parte inicial do jogo.</div>
<div class="block">Renderiza a parte inicial do jogo.</div>
</td>
</tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/com/usp/corrida/utils/Random.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Random (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion docs/com/usp/corrida/utils/Save.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Save (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion docs/com/usp/corrida/utils/Utils.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Utils (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion docs/com/usp/corrida/utils/package-frame.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>com.usp.corrida.utils (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion docs/com/usp/corrida/utils/package-summary.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>com.usp.corrida.utils (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion docs/constant-values.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Constant Field Values (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Corrida Aritmetica - docs</title>
<script type="text/javascript">
tmpTargetPage = "" + window.location.search;
Expand Down
2 changes: 1 addition & 1 deletion docs/overview-frame.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Overview List (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion docs/overview-summary.html
View file
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:01:27 BRT 2020 -->
<!-- Generated by javadoc (1.8.0_252) on Fri Jun 19 01:05:27 BRT 2020 -->
<title>Overview (Corrida Aritmetica - docs)</title>
<meta name="date" content="2020-06-19">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down

0 comments on commit 465f080

Please sign in to comment.