- add clarification about Application/SimpleApplication to javadoc

git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@10118 75d07b2b-3a1a-0410-a2c5-0572b91ccdca
This commit is contained in:
nor..67 2013-01-20 16:39:35 +00:00
parent 7bc7aed6d8
commit da58611fc7
2 changed files with 7 additions and 7 deletions

View File

@ -59,8 +59,7 @@ import java.util.logging.Logger;
* An <code>Application</code> provides all the tools that are commonly used in jME3 * An <code>Application</code> provides all the tools that are commonly used in jME3
* applications. * applications.
* *
* jME3 applications should extend this class and call start() to begin the * jME3 applications *SHOULD NOT EXTEND* this class but extend SimpleApplication instead.
* application.
* *
*/ */
public class Application implements SystemListener { public class Application implements SystemListener {

View File

@ -47,11 +47,9 @@ import com.jme3.system.JmeContext.Type;
import com.jme3.system.JmeSystem; import com.jme3.system.JmeSystem;
/** /**
* <code>SimpleApplication</code> extends the {@link com.jme3.app.Application} * <code>SimpleApplication</code> is the base class for all jME3 Applications.
* class to provide default functionality like a first-person camera, * <code>SimpleApplication</code> will display a statistics view
* and an accessible root node that is updated and rendered regularly. * using the {@link com.jme3.app.StatsAppState} AppState. It will display
* Additionally, <code>SimpleApplication</code> will display a statistics view
* using the {@link com.jme3.app.StatsView} class. It will display
* the current frames-per-second value on-screen in addition to the statistics. * the current frames-per-second value on-screen in addition to the statistics.
* Several keys have special functionality in <code>SimpleApplication</code>:<br/> * Several keys have special functionality in <code>SimpleApplication</code>:<br/>
* *
@ -60,6 +58,9 @@ import com.jme3.system.JmeSystem;
* <tr><td>C</td><td>- Display the camera position and rotation in the console.</td></tr> * <tr><td>C</td><td>- Display the camera position and rotation in the console.</td></tr>
* <tr><td>M</td><td>- Display memory usage in the console.</td></tr> * <tr><td>M</td><td>- Display memory usage in the console.</td></tr>
* </table> * </table>
*
* A {@link com.jme3.app.FlyCamAppState} is by default attached as well and can
* be removed by calling <code>stateManager.detach( stateManager.getState(FlyCamAppState.class) );</code>
*/ */
public abstract class SimpleApplication extends Application { public abstract class SimpleApplication extends Application {