Permalink
Browse files

Javadoc cleanup/update

  • Loading branch information...
1 parent b0410fa commit a6017e4926ae68051b8525a9790b242b26a43d8b @isuro committed Apr 16, 2012
View
@@ -6,9 +6,9 @@
static int x = 5;
static int y = 5;
static int z = 5;
- public static int[][][] location;
- public static String chName = "";
- public static final String EOL = System.getProperty("line.separator");
+ static int[][][] location;
+ static String chName = "";
+ static final String EOL = System.getProperty("line.separator");
public static void main (String[] args)
{
@@ -90,27 +90,27 @@ public static String readInput()
}
/**
- * File should be in the following format:
- *
- * "TOTALNUMBEROFROOMS 3
- * 1 1 1 1
- * This is a description of room 1.
- * F F F F T F
- * 2 1 2 1
- * This is a description of room 2.
- * F F T F F F
- * 3 2 2 1
- * This is a description of room 3.
- * F F T F F F
- * ...
- * 1000 x y z
- * This is a description of room 1000.
- * NExit SExit EExit WExit UpExit DownExit"
- *
- * The first number is the room ID, and the last three numbers are the room's
- * x, y, and z coordinates, respectively. Worlds cannot exceed 1000 rooms
- * (i.e. a 10x10x10 three dimension array).
- *
+ * Reads in the file defining the rooms in the world.
+ * File should be in the following format:<br />
+ * <br />
+ * "TOTALNUMBEROFROOMS 3<br />
+ * 1 1 1 1<br />
+ * This is a description of room 1.<br />
+ * F F F F T F<br />
+ * 2 1 2 1<br />
+ * This is a description of room 2.<br />
+ * F F T F F F<br />
+ * 3 2 2 1<br />
+ * This is a description of room 3.<br />
+ * F F T F F F<br />
+ * ...<br />
+ * 1000 x y z<br />
+ * This is a description of room 1000.<br />
+ * NExit SExit EExit WExit UpExit DownExit"<br />
+ * <br />
+ * The first number is the room ID, and the last three numbers are the room's
+ * x, y, and z coordinates, respectively. Worlds cannot exceed 1000 rooms
+ * (i.e. a 10x10x10 three dimension array).
*/
public static void readSaveFile (String pathname)
{
View
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_31) on Fri Apr 06 20:33:20 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_31) on Mon Apr 16 15:10:27 EDT 2012 -->
<TITLE>
Exe
</TITLE>
-<META NAME="date" CONTENT="2012-04-06">
+<META NAME="date" CONTENT="2012-04-16">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -74,9 +74,9 @@
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
@@ -99,32 +99,7 @@
<HR>
<P>
-<!-- =========== FIELD SUMMARY =========== -->
-<A NAME="field_summary"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
-<B>Field Summary</B></FONT></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
-<TD><CODE><B><A HREF="Exe.html#chName">chName</A></B></CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>static&nbsp;<A HREF="Room.html" title="class in &lt;Unnamed&gt;">Room</A>[][][]</CODE></FONT></TD>
-<TD><CODE><B><A HREF="Exe.html#world">world</A></B></CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-</TABLE>
-&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
@@ -219,11 +194,7 @@
<TD><CODE><B><A HREF="Exe.html#readSaveFile(java.lang.String)">readSaveFile</A></B>(java.lang.String&nbsp;pathname)</CODE>
<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;File should be in the following format:
-
- "TOTALNUMBEROFROOMS 3
- 1 1 1 1
- This is a description of room 1.</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads in the file defining the rooms in the world.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -278,35 +249,6 @@
&nbsp;
<P>
-<!-- ============ FIELD DETAIL =========== -->
-
-<A NAME="field_detail"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
-<B>Field Detail</B></FONT></TH>
-</TR>
-</TABLE>
-
-<A NAME="world"><!-- --></A><H3>
-world</H3>
-<PRE>
-public static <A HREF="Room.html" title="class in &lt;Unnamed&gt;">Room</A>[][][] <B>world</B></PRE>
-<DL>
-<DL>
-</DL>
-</DL>
-<HR>
-
-<A NAME="chName"><!-- --></A><H3>
-chName</H3>
-<PRE>
-public static java.lang.String <B>chName</B></PRE>
-<DL>
-<DL>
-</DL>
-</DL>
-
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
@@ -460,26 +402,27 @@
<PRE>
public static void <B>readSaveFile</B>(java.lang.String&nbsp;pathname)</PRE>
<DL>
-<DD>File should be in the following format:
-
- "TOTALNUMBEROFROOMS 3
- 1 1 1 1
- This is a description of room 1.
- F F F F T F
- 2 1 2 1
- This is a description of room 2.
- F F T F F F
- 3 2 2 1
- This is a description of room 3.
- F F T F F F
- ...
- 1000 x y z
- This is a description of room 1000.
- NExit SExit EExit WExit UpExit DownExit"
-
- The first number is the room ID, and the last three numbers are the room's
- x, y, and z coordinates, respectively. Worlds cannot exceed 1000 rooms
- (i.e. a 10x10x10 three dimension array).
+<DD>Reads in the file defining the rooms in the world.
+ File should be in the following format:<br />
+ <br />
+ "TOTALNUMBEROFROOMS 3<br />
+ 1 1 1 1<br />
+ This is a description of room 1.<br />
+ F F F F T F<br />
+ 2 1 2 1<br />
+ This is a description of room 2.<br />
+ F F T F F F<br />
+ 3 2 2 1<br />
+ This is a description of room 3.<br />
+ F F T F F F<br />
+ ...<br />
+ 1000 x y z<br />
+ This is a description of room 1000.<br />
+ NExit SExit EExit WExit UpExit DownExit"<br />
+ <br />
+ The first number is the room ID, and the last three numbers are the room's
+ x, y, and z coordinates, respectively. Worlds cannot exceed 1000 rooms
+ (i.e. a 10x10x10 three dimension array).
<P>
<DD><DL>
</DL>
@@ -557,9 +500,9 @@
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
View
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_31) on Fri Apr 06 20:33:20 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_31) on Mon Apr 16 15:10:27 EDT 2012 -->
<TITLE>
Item
</TITLE>
-<META NAME="date" CONTENT="2012-04-06">
+<META NAME="date" CONTENT="2012-04-16">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -109,6 +109,12 @@
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="Item.html#Item(java.lang.String)">Item</A></B>(java.lang.String&nbsp;data)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="Item.html#Item(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, Item[], int, boolean, java.lang.String[][])">Item</A></B>(java.lang.String&nbsp;itemName,
java.lang.String&nbsp;itemShortName,
java.lang.String&nbsp;itemDescription,
@@ -298,6 +304,14 @@
java.lang.String[][]&nbsp;itemDialogue)</PRE>
<DL>
</DL>
+<HR>
+
+<A NAME="Item(java.lang.String)"><!-- --></A><H3>
+Item</H3>
+<PRE>
+public <B>Item</B>(java.lang.String&nbsp;data)</PRE>
+<DL>
+</DL>
<!-- ============ METHOD DETAIL ========== -->
Oops, something went wrong.

0 comments on commit a6017e4

Please sign in to comment.