Skip to content

Latest commit

 

History

History
241 lines (238 loc) · 15.2 KB

TODO.md

File metadata and controls

241 lines (238 loc) · 15.2 KB

TODO

  • Update javadoc according to log bellow
  • Complete CollisionSystem to make it highlight colliding entities.

file: javadoc.log

C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:39: error: unexpected end tag: </p>
 * </p>
   ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:53: error: unexpected end tag: </p>
 * </p>
   ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\scenes\AbstractScene.java:34: warning: empty <strong> tag
 * <strong></strong>
           ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\Game.java:85: warning: no @param for argv
    public void initialize(String[] argv) throws ArgumentUnknownException {
                ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\Game.java:85: warning: no @throws for fr.snapgames.fromclasstogame.core.config.cli.exception.ArgumentUnknownException
    public void initialize(String[] argv) throws ArgumentUnknownException {
                ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\Game.java:118: warning: no description for @throws
     * @throws ArgumentUnknownException
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\Game.java:120: warning: no @param for argv
    public void run(String argv[]) throws ArgumentUnknownException {
                ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\Game.java:188: warning: no @param for dt
    public void update(long dt) {
                ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\entity\particles\ParticleSystem.java:79: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\entity\particles\ParticleSystem.java:102: error: unknown tag: Particle
     * On particle Creation, call for any Behavior<Particle> proposing a `onCreate` implementation
                                                  ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\entity\particles\ParticleSystem.java:113: error: unknown tag: Particle
     * Update process to update all particles with this ParticleSystem  Behavior<Particle>'s.
                                                                                ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\entity\particles\ParticleSystem.java:138: error: unknown tag: Particle
     * Add a new Behavior<Particle> tio ths ParticleSystem.
                         ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\entity\particles\ParticleSystem.java:141: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\entity\particles\ParticleSystem.java:163: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\entity\particles\ParticleSystem.java:172: warning: no description for @param
     * @param b
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:85: warning: no description for @param
     * @param title
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:86: warning: no description for @param
     * @param width
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:87: warning: no description for @param
     * @param height
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:98: warning: no description for @param
     * @param config
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:210: warning: no description for @param
     * @param realFPS
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:211: warning: no description for @param
     * @param g
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:240: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:355: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:364: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:373: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:382: warning: no description for @param
     * @param d
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:391: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\Window.java:398: error: unknown tag: ink
     * Add a {@link KeyListener} <code>listener</code> to the Window {@ink JFrame}.
                                                                     ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\renderer\AbstractRenderHelper.java:216: error: bad use of '>'
     * If {@link GameObject#getDebug()} >= {@link Window#getDebug()}, and
                                        ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\renderer\AbstractRenderHelper.java:217: error: bad use of '>'
     * {@link Window#getDebug()}>0, display the debug information.
                                ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\renderer\AbstractRenderHelper.java:272: error: bad use of '>'
     * from min => max value
                 ^
javadoc: warning - invalid usage of tag >
javadoc: warning - invalid usage of tag >
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\gfx\renderer\LightObjectRenderHelper.java:104: error: incorrect use of inline tag
     * @link https://stackoverflow.com/questions/18648142/creating-brighter-color-java
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\io\I18n.java:22: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\io\I18n.java:33: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\io\actions\ActionHandler.java:83: warning: no description for @param
     * @param g
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\io\actions\ActionHandler.java:151: warning: no description for @param
     * @param keyMapping
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\io\actions\ActionHandler.java:221: warning: no @param for actionCode
    public boolean getAction(Integer actionCode) {
                   ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\PhysicEngine.java:100: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\PhysicEngine.java:278: warning: no @return
    private Vector2d applyWorldInfluenceArea2dList(GameObject go) {
                     ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\PhysicEngine.java:310: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\PhysicEngine.java:374: warning: no description for @param
     * @param debugFlagKey
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\PhysicEngine.java:375: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\PhysicEngine.java:384: warning: no description for @param
     * @param debugFlagKey
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\PhysicEngine.java:385: warning: no description for @param
     * @param value
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\PhysicEngine.java:394: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\Vector2d.java:27: warning: no description for @param
     * @param x
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\Vector2d.java:28: warning: no description for @param
     * @param y
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\Vector2d.java:40: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\Vector2d.java:51: warning: no @return
    public Vector2d normalize() {
                    ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\Vector2d.java:126: warning: no description for @param
     * @param v1
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\Vector2d.java:127: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\physic\World.java:44: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\scenes\AbstractScene.java:125: warning: no description for @param
     * @param filteredName
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\scenes\AbstractScene.java:126: warning: no description for @return
     * @return
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\core\scenes\SceneManager.java:133: warning: no @param for name
    public void add(String name, Scene s) {
                ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\InventoryRenderHelper.java:32: warning: no description for @param
     * @param r
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\InventoryRenderHelper.java:53: warning: no description for @param
     * @param g
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\InventoryRenderHelper.java:54: warning: no description for @param
     * @param o
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\InventoryRenderHelper.java:89: warning: no description for @param
     * @param g
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\InventoryRenderHelper.java:90: warning: no description for @param
     * @param go
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\LifeRenderHelper.java:52: warning: no description for @param
     * @param g
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\LifeRenderHelper.java:53: warning: no description for @param
     * @param value
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\LifeRenderHelper.java:54: warning: no description for @param
     * @param x
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\LifeRenderHelper.java:55: warning: no description for @param
     * @param y
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\LifeRenderHelper.java:66: warning: no description for @param
     * @param g
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\LifeRenderHelper.java:67: warning: no description for @param
     * @param value
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\LifeRenderHelper.java:68: warning: no description for @param
     * @param x
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\LifeRenderHelper.java:69: warning: no description for @param
     * @param y
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\ScoreRenderHelper.java:45: warning: no description for @param
     * @param g
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\ScoreRenderHelper.java:46: warning: no description for @param
     * @param score
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\ScoreRenderHelper.java:47: warning: no description for @param
     * @param x
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\ScoreRenderHelper.java:48: warning: no description for @param
     * @param y
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\ScoreRenderHelper.java:61: warning: no description for @param
     * @param g
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\ScoreRenderHelper.java:62: warning: no description for @param
     * @param value
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\ScoreRenderHelper.java:63: warning: no description for @param
     * @param x
       ^
C:\Users\frede\Projects\java\fromClassToGame\src\main\java\fr\snapgames\fromclasstogame\demo\renderer\ScoreRenderHelper.java:64: warning: no description for @param
     * @param y
       ^
Command line was: cmd.exe /X /C "C:\Users\frede\tools\java\jdk\11.0.11.9-hotspot\bin\javadoc.exe @options @packages @argfile"
Refer to the generated Javadoc files in 'C:\Users\frede\Projects\java\fromClassToGame\target\apidocs' dir.