Revision: 1065
http://japi.svn.sourceforge.net/japi/?rev=1065&view=rev
Author: christianhujer
Date: 2009-02-22 21:57:54 +0000 (Sun, 22 Feb 2009)
Log Message:
-----------
Added missing javadoc documentation.
Modified Paths:
--------------
games/jmines/trunk/src/prj/net/sf/japi/games/jmines/JMines.java
games/jmines/trunk/src/prj/net/sf/japi/games/jmines/package-info.java
Modified: games/jmines/trunk/src/prj/net/sf/japi/games/jmines/JMines.java
===================================================================
--- games/jmines/trunk/src/prj/net/sf/japi/games/jmines/JMines.java 2009-02-22 20:55:24 UTC (rev 1064)
+++ games/jmines/trunk/src/prj/net/sf/japi/games/jmines/JMines.java 2009-02-22 21:57:54 UTC (rev 1065)
@@ -26,9 +26,11 @@
*/
public class JMines extends JApplet {
+ /** Creates JMines. */
public JMines() {
}
+ /** Starts a new game. */
@ActionMethod
public void newGame() {
@@ -36,14 +38,26 @@
}
+/** State of a single JMines field element. */
enum FieldState {
+
+ /** The field is closed. */
CLOSED,
+
+ /** The field is closed and flagged by the user as suspected of having a mine. */
FLAGGED,
+
+ /** The field is closed and flagged by the user as being of unknown state. */
UNKNOWN,
+
+ /** The field is open. */
OPEN,
+
+ /** The field is open and has a mine. */
MINE
}
+/** A field. */
interface Field {
/** Returns the width of this mine field.
@@ -62,10 +76,15 @@
int getMineCount();
}
+/** View for a single field. */
class FieldView extends JComponent {
+ /** The field to view. */
private Field field;
+ /** Sets the field to view.
+ * @param field Field to view.
+ */
public void setField(final Field field) {
this.field = field;
}
Modified: games/jmines/trunk/src/prj/net/sf/japi/games/jmines/package-info.java
===================================================================
--- games/jmines/trunk/src/prj/net/sf/japi/games/jmines/package-info.java 2009-02-22 20:55:24 UTC (rev 1064)
+++ games/jmines/trunk/src/prj/net/sf/japi/games/jmines/package-info.java 2009-02-22 21:57:54 UTC (rev 1065)
@@ -0,0 +1,4 @@
+/** Contains an implementation of the popular game "Minesweeper" in Java.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ */
+package net.sf.japi.games.jmines;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
