djib/Sushi
1
0
Fork 0
Code Issues 2 Pull Requests Releases 1 Activity

Documentation generated. Some errors corrected in the code.

Browse Source
This commit is contained in:
Jean-Baptiste Hétier
2006-01-13 17:03:06 +00:00
parent 5a8d3829be
commit 9167829467
34 changed files with 1307 additions and 478 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
doc/index-files/index-5.html
View File

@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.4.2-02) on Tue Jan 10 15:14:09 GMT 2006 -->
<!-- Generated by javadoc (build 1.5.0_05) on Fri Jan 13 17:00:38 GMT 2006 -->
<TITLE>
I-Index
G-Index
</TITLE>
@@ -13,9 +13,11 @@ I-Index
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="I-Index";
parent.document.title="G-Index";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
@@ -27,14 +29,14 @@ function windowTitle()
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../suicideChess/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../suicideChess/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Index</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
@@ -51,7 +53,7 @@ function windowTitle()
&nbsp;<A HREF="index-4.html"><B>PREV LETTER</B></A>&nbsp;
&nbsp;<A HREF="index-6.html"><B>NEXT LETTER</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
<A HREF="../index.html?index-filesindex-5.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="index-5.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
@@ -64,22 +66,61 @@ function windowTitle()
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<A HREF="index-1.html">B</A> <A HREF="index-2.html">D</A> <A HREF="index-3.html">F</A> <A HREF="index-4.html">G</A> <A HREF="index-5.html">I</A> <A HREF="index-6.html">M</A> <A HREF="index-7.html">N</A> <A HREF="index-8.html">S</A> <A HREF="index-9.html">T</A> <HR>
<A NAME="_I_"><!-- --></A><H2>
<B>I</B></H2>
<A HREF="index-1.html">B</A> <A HREF="index-2.html">D</A> <A HREF="index-3.html">E</A> <A HREF="index-4.html">F</A> <A HREF="index-5.html">G</A> <A HREF="index-6.html">I</A> <A HREF="index-7.html">K</A> <A HREF="index-8.html">L</A> <A HREF="index-9.html">M</A> <A HREF="index-10.html">N</A> <A HREF="index-11.html">P</A> <A HREF="index-12.html">Q</A> <A HREF="index-13.html">R</A> <A HREF="index-14.html">S</A> <A HREF="index-15.html">T</A> <A HREF="index-16.html">W</A> <HR>
<A NAME="_G_"><!-- --></A><H2>
<B>G</B></H2>
<DL>
<DT><A HREF="../suicideChess/Move.html#isCaptureMove()"><B>isCaptureMove()</B></A> -
<DT><A HREF="../suicideChess/Move.html#getCapturedPiece()"><B>getCapturedPiece()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Move.html" title="class in suicideChess">Move</A>
<DD>Returns a boolean saying if a Move is a capture move
<DT><A HREF="../suicideChess/Move.html#isPromotionMove()"><B>isPromotionMove()</B></A> -
<DD>Returns the <A HREF="../suicideChess/Piece.html" title="class in suicideChess"><CODE>Piece</CODE></A> to be captured in a Move
<DT><A HREF="../suicideChess/Piece.html#getColor()"><B>getColor()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Piece.html" title="class in suicideChess">Piece</A>
<DD>Returns an integer representing the color of the Piece.
<DT><A HREF="../suicideChess/Board.html#getEnPassantSquare()"><B>getEnPassantSquare()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Board.html" title="class in suicideChess">Board</A>
<DD>This function is used to return the 'en passant' Square.
<DT><A HREF="../suicideChess/Move.html#getEnPassantSquare()"><B>getEnPassantSquare()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Move.html" title="class in suicideChess">Move</A>
<DD>Returns a boolean saying if a Move is a promotion or not.
<DD>Returns the enPassant Square for a move.
<DT><A HREF="../suicideChess/Square.html#getFile()"><B>getFile()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A>
<DD>Returns the file of a Square.
<DT><A HREF="../suicideChess/Square.html#getFileNb()"><B>getFileNb()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A>
<DD>Returns the number of the File
<DT><A HREF="../suicideChess/Rules.html#getLegalMovesCapture()"><B>getLegalMovesCapture()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Rules.html" title="class in suicideChess">Rules</A>
<DD>This function return the current status of the ArrayList<Move> of all legal <A HREF="../suicideChess/Move.html" title="class in suicideChess"><CODE>Move</CODE></A>
with a capture.
<DT><A HREF="../suicideChess/Rules.html#getLegalMovesNonCapture()"><B>getLegalMovesNonCapture()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Rules.html" title="class in suicideChess">Rules</A>
<DD>This function return the current status of the ArrayList<Move> of all legal <A HREF="../suicideChess/Move.html" title="class in suicideChess"><CODE>Move</CODE></A>
without a capture.
<DT><A HREF="../suicideChess/Move.html#getMovingPiece()"><B>getMovingPiece()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Move.html" title="class in suicideChess">Move</A>
<DD>Returns the moving <A HREF="../suicideChess/Piece.html" title="class in suicideChess"><CODE>Piece</CODE></A> of a Move.
<DT><A HREF="../suicideChess/Board.html#getPiece(suicideChess.Square)"><B>getPiece(Square)</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Board.html" title="class in suicideChess">Board</A>
<DD>This function searchs for what piece is on a square.
<DT><A HREF="../suicideChess/Piece.html#getPieceNumber()"><B>getPieceNumber()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Piece.html" title="class in suicideChess">Piece</A>
<DD>Returns an integer representing the Piece (Piece.BLACK_PAWN or Piece.WHITE_QUEEN)
<DT><A HREF="../suicideChess/Piece.html#getPieceType()"><B>getPieceType()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Piece.html" title="class in suicideChess">Piece</A>
<DD>Returns an integer representing the Piece type (Piece.QUEEN or Piece.PAWN)
<DT><A HREF="../suicideChess/Move.html#getPromotionPiece()"><B>getPromotionPiece()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Move.html" title="class in suicideChess">Move</A>
<DD>Returns the promotion <A HREF="../suicideChess/Piece.html" title="class in suicideChess"><CODE>Piece</CODE></A> of a Move
<DT><A HREF="../suicideChess/Square.html#getRank()"><B>getRank()</B></A> -
Method in class suicideChess.<A HREF="../suicideChess/Square.html" title="class in suicideChess">Square</A>
<DD>Returns the number of the Rank
</DL>
<HR>
@@ -89,14 +130,14 @@ Method in class suicideChess.<A HREF="../suicideChess/Move.html" title="class in
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../suicideChess/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../suicideChess/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Index</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
@@ -113,7 +154,7 @@ Method in class suicideChess.<A HREF="../suicideChess/Move.html" title="class in
&nbsp;<A HREF="index-4.html"><B>PREV LETTER</B></A>&nbsp;
&nbsp;<A HREF="index-6.html"><B>NEXT LETTER</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
<A HREF="../index.html?index-filesindex-5.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="index-5.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
@@ -126,13 +167,14 @@ Method in class suicideChess.<A HREF="../suicideChess/Move.html" title="class in
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<A HREF="index-1.html">B</A> <A HREF="index-2.html">D</A> <A HREF="index-3.html">F</A> <A HREF="index-4.html">G</A> <A HREF="index-5.html">I</A> <A HREF="index-6.html">M</A> <A HREF="index-7.html">N</A> <A HREF="index-8.html">S</A> <A HREF="index-9.html">T</A> <HR>
<A HREF="index-1.html">B</A> <A HREF="index-2.html">D</A> <A HREF="index-3.html">E</A> <A HREF="index-4.html">F</A> <A HREF="index-5.html">G</A> <A HREF="index-6.html">I</A> <A HREF="index-7.html">K</A> <A HREF="index-8.html">L</A> <A HREF="index-9.html">M</A> <A HREF="index-10.html">N</A> <A HREF="index-11.html">P</A> <A HREF="index-12.html">Q</A> <A HREF="index-13.html">R</A> <A HREF="index-14.html">S</A> <A HREF="index-15.html">T</A> <A HREF="index-16.html">W</A> <HR>
</BODY>
</HTML>