Updated readability of the code.

[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / gui / humaninput / MouseEvent.java

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/gui/humaninput/MouseEvent.java b/src/main/java/eu/svjatoslav/sixth/e3d/gui/humaninput/MouseEvent.java
index 6218a3a..459d0d2 100644 (file)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/gui/humaninput/MouseEvent.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/gui/humaninput/MouseEvent.java
@@ -1,23 +1,29 @@
 /*
- * Sixth 3D engine. Copyright ©2012-2019, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of version 3 of the GNU Lesser General Public License
- * or later as published by the Free Software Foundation.
- *
+ * Sixth 3D engine. Author: Svjatoslav Agejenko.
+ * This project is released under Creative Commons Zero (CC0) license.
  */
-
 package eu.svjatoslav.sixth.e3d.gui.humaninput;
 
 import eu.svjatoslav.sixth.e3d.geometry.Point2D;
 
+/**
+ * Represents mouse event.
+ */
 public class MouseEvent {
 
+    /**
+     * Mouse coordinate in screen space (pixels) relative to top left corner of the screen
+     * when mouse button was clicked.
+     */
     public Point2D coordinate;
 
     /**
-     * Indicates pressed mouse button. Except 0 that simply means mouse over
-     * given region.
+     * <pre>
+     * 0 - mouse over (no button pressed)
+     * 1 - left mouse button
+     * 2 - middle mouse button
+     * 3 - right mouse button
+     * </pre>
      */
     public int button;