Permalink
Browse files

Make comments more compact

  • Loading branch information...
1 parent 01e2467 commit 8a713fe949bf62b051376595d3566c548b9274b2 @enz enz committed Feb 28, 2010
Showing with 634 additions and 1,250 deletions.
  1. +1 −2 mac/src/net/sf/gogui/specialmac/RegisterSpecialMacHandler.java
  2. +2 −4 src/net/sf/gogui/boardpainter/BoardPainter.java
  3. +2 −4 src/net/sf/gogui/boardpainter/BoardPainterUtil.java
  4. +1 −2 src/net/sf/gogui/boardpainter/ConstField.java
  5. +1 −2 src/net/sf/gogui/boardpainter/Field.java
  6. +1 −2 src/net/sf/gogui/boardpainter/RadialGradientContext.java
  7. +1 −2 src/net/sf/gogui/boardpainter/RadialGradientPaint.java
  8. +1 −2 src/net/sf/gogui/game/BoardUpdater.java
  9. +12 −24 src/net/sf/gogui/game/Clock.java
  10. +1 −2 src/net/sf/gogui/game/ConstClock.java
  11. +1 −2 src/net/sf/gogui/game/ConstGame.java
  12. +1 −2 src/net/sf/gogui/game/ConstGameInfo.java
  13. +1 −2 src/net/sf/gogui/game/ConstGameTree.java
  14. +1 −2 src/net/sf/gogui/game/ConstNode.java
  15. +1 −2 src/net/sf/gogui/game/ConstSgfProperties.java
  16. +8 −16 src/net/sf/gogui/game/Game.java
  17. +5 −10 src/net/sf/gogui/game/GameInfo.java
  18. +4 −8 src/net/sf/gogui/game/GameTree.java
  19. +1 −2 src/net/sf/gogui/game/MarkType.java
  20. +52 −104 src/net/sf/gogui/game/Node.java
  21. +29 −54 src/net/sf/gogui/game/NodeUtil.java
  22. +2 −4 src/net/sf/gogui/game/SgfProperties.java
  23. +9 −18 src/net/sf/gogui/game/TimeSettings.java
  24. +1 −2 src/net/sf/gogui/gamefile/GameFileFilter.java
  25. +1 −2 src/net/sf/gogui/gamefile/GameFileUtil.java
  26. +1 −2 src/net/sf/gogui/gamefile/GameReader.java
  27. +1 −2 src/net/sf/gogui/go/BlackWhiteEmptySet.java
  28. +31 −60 src/net/sf/gogui/go/Board.java
  29. +6 −12 src/net/sf/gogui/go/BoardConstants.java
  30. +5 −10 src/net/sf/gogui/go/BoardUtil.java
  31. +1 −2 src/net/sf/gogui/go/ConstBoard.java
  32. +1 −2 src/net/sf/gogui/go/ConstPointList.java
  33. +7 −14 src/net/sf/gogui/go/CountScore.java
  34. +4 −8 src/net/sf/gogui/go/GoColor.java
  35. +15 −30 src/net/sf/gogui/go/GoPoint.java
  36. +1 −2 src/net/sf/gogui/go/InvalidPointException.java
  37. +3 −6 src/net/sf/gogui/go/Komi.java
  38. +8 −16 src/net/sf/gogui/go/Marker.java
  39. +7 −14 src/net/sf/gogui/go/Move.java
  40. +1 −2 src/net/sf/gogui/go/MoveUtil.java
  41. +7 −14 src/net/sf/gogui/go/PointList.java
  42. +1 −2 src/net/sf/gogui/go/Score.java
  43. +16 −30 src/net/sf/gogui/gogui/GoGui.java
  44. +2 −4 src/net/sf/gogui/gogui/GoGuiActions.java
  45. +2 −4 src/net/sf/gogui/gogui/GoGuiSettings.java
  46. +1 −2 src/net/sf/gogui/gogui/Interrupt.java
  47. +1 −2 src/net/sf/gogui/gogui/Main.java
  48. +1 −2 src/net/sf/gogui/gogui/MainWrapper.java
  49. +1 −2 src/net/sf/gogui/gogui/ShowAnalyzeText.java
  50. +1 −2 src/net/sf/gogui/gtp/AnalyzeCommand.java
  51. +2 −4 src/net/sf/gogui/gtp/AnalyzeDefinition.java
  52. +1 −2 src/net/sf/gogui/gtp/AnalyzeType.java
  53. +2 −4 src/net/sf/gogui/gtp/AnalyzeUtil.java
  54. +1 −2 src/net/sf/gogui/gtp/GtpCallback.java
  55. +14 −28 src/net/sf/gogui/gtp/GtpClient.java
  56. +30 −58 src/net/sf/gogui/gtp/GtpClientBase.java
  57. +3 −6 src/net/sf/gogui/gtp/GtpClientUtil.java
  58. +25 −50 src/net/sf/gogui/gtp/GtpCommand.java
  59. +10 −18 src/net/sf/gogui/gtp/GtpEngine.java
  60. +1 −2 src/net/sf/gogui/gtp/GtpError.java
  61. +1 −2 src/net/sf/gogui/gtp/GtpResponseFormatError.java
  62. +6 −12 src/net/sf/gogui/gtp/GtpSynchronizer.java
  63. +4 −8 src/net/sf/gogui/gtp/GtpUtil.java
  64. +1 −2 src/net/sf/gogui/gtp/ParameterType.java
  65. +2 −4 src/net/sf/gogui/gui/AnalyzeDialog.java
  66. +3 −6 src/net/sf/gogui/gui/AnalyzeShow.java
  67. +1 −2 src/net/sf/gogui/gui/ConstGuiBoard.java
  68. +3 −6 src/net/sf/gogui/gui/FileDialogs.java
  69. +1 −2 src/net/sf/gogui/gui/GameTreePanel.java
  70. +1 −2 src/net/sf/gogui/gui/GtpShellText.java
  71. +31 −62 src/net/sf/gogui/gui/GuiBoard.java
  72. +2 −4 src/net/sf/gogui/gui/GuiBoardUtil.java
  73. +4 −8 src/net/sf/gogui/gui/GuiGtpClient.java
  74. +16 −32 src/net/sf/gogui/gui/GuiUtil.java
  75. +2 −4 src/net/sf/gogui/gui/Help.java
  76. +2 −4 src/net/sf/gogui/gui/LiveGfx.java
  77. +4 −6 src/net/sf/gogui/gui/MessageDialogs.java
  78. +1 −2 src/net/sf/gogui/gui/ParameterDialog.java
  79. +2 −4 src/net/sf/gogui/gui/Program.java
  80. +1 −2 src/net/sf/gogui/gui/ProgramEditor.java
  81. +1 −2 src/net/sf/gogui/gui/RecentFileMenu.java
  82. +1 −2 src/net/sf/gogui/gui/RecentMenu.java
  83. +6 −12 src/net/sf/gogui/gui/SquareLayout.java
  84. +3 −6 src/net/sf/gogui/gui/StatusBar.java
  85. +1 −2 src/net/sf/gogui/gui/SwitchLanguageDialog.java
  86. +1 −2 src/net/sf/gogui/sgf/SgfError.java
  87. +7 −14 src/net/sf/gogui/sgf/SgfReader.java
  88. +2 −4 src/net/sf/gogui/sgf/SgfUtil.java
  89. +2 −4 src/net/sf/gogui/sgf/SgfWriter.java
  90. +4 −8 src/net/sf/gogui/text/TextParser.java
  91. +4 −8 src/net/sf/gogui/thumbnail/ThumbnailCreator.java
  92. +1 −2 src/net/sf/gogui/thumbnail/ThumbnailReader.java
  93. +4 −8 src/net/sf/gogui/thumbnail/ThumbnailUtil.java
  94. +3 −6 src/net/sf/gogui/tools/adapter/Adapter.java
  95. +1 −2 src/net/sf/gogui/tools/display/Display.java
  96. +1 −2 src/net/sf/gogui/tools/dummy/Dummy.java
  97. +6 −12 src/net/sf/gogui/tools/regress/Regress.java
  98. +2 −4 src/net/sf/gogui/tools/regress/RegressUtil.java
  99. +1 −2 src/net/sf/gogui/tools/server/Server.java
  100. +13 −26 src/net/sf/gogui/tools/statistics/Plot.java
  101. +5 −10 src/net/sf/gogui/tools/statistics/Statistics.java
  102. +1 −2 src/net/sf/gogui/tools/terminal/Terminal.java
  103. +1 −2 src/net/sf/gogui/tools/thumbnailer/Main.java
  104. +2 −4 src/net/sf/gogui/tools/twogtp/Compare.java
  105. +3 −6 src/net/sf/gogui/tools/twogtp/Program.java
  106. +4 −6 src/net/sf/gogui/tools/twogtp/TwoGtp.java
  107. +2 −4 src/net/sf/gogui/util/ErrorMessage.java
  108. +6 −12 src/net/sf/gogui/util/FileUtil.java
  109. +1 −2 src/net/sf/gogui/util/HtmlUtil.java
  110. +17 −32 src/net/sf/gogui/util/Options.java
  111. +7 −14 src/net/sf/gogui/util/Platform.java
  112. +4 −8 src/net/sf/gogui/util/PrefUtil.java
  113. +2 −4 src/net/sf/gogui/util/ProcessUtil.java
  114. +4 −8 src/net/sf/gogui/util/RecentFileStorage.java
  115. +10 −20 src/net/sf/gogui/util/Statistics.java
  116. +2 −4 src/net/sf/gogui/util/StreamCopy.java
  117. +1 −2 src/net/sf/gogui/util/StreamDiscard.java
  118. +6 −12 src/net/sf/gogui/util/StringUtil.java
  119. +4 −8 src/net/sf/gogui/util/Table.java
  120. +3 −6 src/net/sf/gogui/util/TableUtil.java
  121. +2 −4 src/net/sf/gogui/util/XmlUtil.java
  122. +8 −16 src/net/sf/gogui/xml/XmlReader.java
  123. +2 −4 src/net/sf/gogui/xml/XmlWriter.java
  124. +1 −2 test/junit/src/net/sf/gogui/game/BoardUpdaterTest.java
  125. +1 −2 test/junit/src/net/sf/gogui/game/ClockTest.java
  126. +1 −2 test/junit/src/net/sf/gogui/game/GameTest.java
  127. +1 −2 test/junit/src/net/sf/gogui/game/NodeUtilTest.java
  128. +1 −2 test/junit/src/net/sf/gogui/go/BoardConstantsTest.java
  129. +1 −2 test/junit/src/net/sf/gogui/go/BoardTest.java
  130. +1 −2 test/junit/src/net/sf/gogui/gtp/AnalyzeCommandTest.java
  131. +1 −2 test/junit/src/net/sf/gogui/gtp/GtpEngineClient.java
  132. +1 −2 test/junit/src/net/sf/gogui/gtp/GtpEngineConnection.java
  133. +1 −2 test/junit/src/net/sf/gogui/gtp/GtpExpectEngine.java
  134. +3 −6 test/junit/src/net/sf/gogui/gtp/GtpSynchronizerTest.java
  135. +2 −4 test/junit/src/net/sf/gogui/sgf/SgfReaderTest.java
  136. +1 −2 test/junit/src/net/sf/gogui/sgf/SgfWriterTest.java
  137. +1 −2 test/junit/src/net/sf/gogui/tex/TexWriterTest.java
  138. +1 −2 test/junit/src/net/sf/gogui/text/TextParserTest.java
  139. +2 −4 test/junit/src/net/sf/gogui/thumbnail/ThumbnailUtilTest.java
  140. +3 −6 test/junit/src/net/sf/gogui/tools/adapter/AdapterTest.java
  141. +2 −4 test/junit/src/net/sf/gogui/xml/XmlReaderTest.java
  142. +6 −12 test/junit/src/net/sf/gogui/xml/XmlWriterTest.java
@@ -35,8 +35,7 @@ public void handleQuit(ApplicationEvent event)
/** Registration of handler for events from Mac Application menu.
This class depends on com.apple and should therefore only
- loaded if the platform is Mac using reflection.
- */
+ loaded if the platform is Mac using reflection. */
public class RegisterSpecialMacHandler
{
public RegisterSpecialMacHandler(Platform.SpecialMacHandler handler)
@@ -37,8 +37,7 @@ public BoardPainter()
@param graphics The graphics object.
@param field The fields.
@param width The width/height of the image.
- @param showGrid Show grid coordinates.
- */
+ @param showGrid Show grid coordinates. */
public void draw(Graphics graphics, ConstField[][] field, int width,
boolean showGrid)
{
@@ -108,8 +107,7 @@ to ensure that all fields have exactly the same size (in pixels).
If a preferred field size is known (e.g. from a different board size,
or from the last settings), then using the board size returned by this
function will draw the board such that the field size is exactly the
- preferred one.
- */
+ preferred one. */
public static Dimension getPreferredSize(int preferredFieldSize,
int boardSize, boolean showGrid)
{
@@ -27,8 +27,7 @@ public static BufferedImage createImage(int width, int height)
}
/** Use a painter to paint the board in a buffered image.
- The image can be written to a file with writeImage().
- */
+ The image can be written to a file with writeImage(). */
public static BufferedImage getImage(BoardPainter painter,
ConstField[][] field, int width,
int height)
@@ -41,8 +40,7 @@ public static BufferedImage getImage(BoardPainter painter,
}
/** Write an image in PNG format to a file.
- @param metaData Optional PNG meta data (or null)
- */
+ @param metaData Optional PNG meta data (or null) */
public static void writeImage(BufferedImage image, File file,
Map<String,String> metaData)
throws IOException
@@ -8,8 +8,7 @@
import net.sf.gogui.go.GoColor;
/** Const functions of Field.
- @see Field
-*/
+ @see Field */
public interface ConstField
{
void draw(Graphics graphics, int size, int x, int y, Image boardImage,
@@ -206,8 +206,7 @@ public void setSelect(boolean select)
It can be used to display stones which are not part of the current
board position (e.g. search variations)
@param color The color of the shadow stone or null to remove a
- shadow stone.
- */
+ shadow stone. */
public void setGhostStone(GoColor color)
{
m_ghostStone = color;
@@ -20,8 +20,7 @@
@param focus Focus shift away from the center along second radius
normalized to interval between zero and one.
@param color1 First color.
- @param color2 Second color.
- */
+ @param color2 Second color. */
public RadialGradientContext(Point2D center, Point2D radius1,
Point2D radius2, double focus, Color color1,
Color color2)
@@ -23,8 +23,7 @@
@param focus Focus shift away from the center along second radius
normalized to interval between zero and one.
@param color1 First color.
- @param color2 Second color.
- */
+ @param color2 Second color. */
public RadialGradientPaint(Point2D center, Point2D radius1,
Point2D radius2, double focus, Color color1,
Color color2)
@@ -85,7 +85,6 @@ else if (player != null)
}
/** Local variable used in update.
- Member variable for avoiding frequent new memory allocations.
- */
+ Member variable for avoiding frequent new memory allocations. */
private final ArrayList<ConstNode> m_nodes;
}
@@ -13,8 +13,7 @@
/** Time control for a Go game.
If the clock is not initialized with Clock.setTimeSettings, the clock
will count upwards, otherwise the time settings with main and/or
- byoyomi time are used. The time unit is milliseconds.
-*/
+ byoyomi time are used. The time unit is milliseconds. */
public final class Clock
implements ConstClock
{
@@ -36,8 +35,7 @@ public long currentTimeMillis()
/** Listener to clock changes.
This function will be called from a different thread at regular
- intervals.
- */
+ intervals. */
public interface Listener
{
void clockChanged();
@@ -55,17 +53,15 @@ public Clock(TimeSource timeSource)
}
/** Get moves left.
- Requires: getUseByoyomi() and isInByoyomi(color)
- */
+ Requires: getUseByoyomi() and isInByoyomi(color) */
public int getMovesLeft(GoColor color)
{
assert getUseByoyomi() && isInByoyomi(color);
return getRecord(color).m_movesLeft;
}
/** Get time left.
- Requires: isInitialized()
- */
+ Requires: isInitialized() */
public long getTimeLeft(GoColor color)
{
assert isInitialized();
@@ -109,8 +105,7 @@ public String getTimeString(GoColor color)
/** Format time left to a string.
If movesLeft &lt; 0, only the time will be returned, otherwise
after the time string, a slash and the number of moves left will be
- appended.
- */
+ appended. */
public static String getTimeString(double timeLeft, int movesLeft)
{
StringBuilder buffer = new StringBuilder(8);
@@ -124,8 +119,7 @@ public static String getTimeString(double timeLeft, int movesLeft)
}
/** Return color the clock is currently measuring the time for.
- Returns null, if clock is between a #stopMove and #startMove.
- */
+ Returns null, if clock is between a #stopMove and #startMove. */
public GoColor getToMove()
{
return m_toMove;
@@ -180,8 +174,7 @@ public boolean lostOnTime(GoColor color)
/** Parses a time string.
The expected format is <tt>[[H:]MM:]SS</tt>.
@return The time in milliseconds or -1, if the time string is not
- valid.
- */
+ valid. */
public static long parseTimeString(String s)
{
String a[] = s.split(":");
@@ -258,8 +251,7 @@ public void resume()
Only one listener supported at the moment.
If the clock has a listener, the clock should be stopped with halt()
if it is no longer used, otherwise the timer thread can keep an
- application from terminating.
- */
+ application from terminating. */
public void setListener(Listener listener)
{
m_listener = listener;
@@ -268,8 +260,7 @@ public void setListener(Listener listener)
/** Set time settings.
Changing the time settings does not change the current state of the
clock. The time settings are only used when the clock is reset or
- the next byoyomi period is initialized.
- */
+ the next byoyomi period is initialized. */
public void setTimeSettings(TimeSettings settings)
{
m_timeSettings = settings;
@@ -278,8 +269,7 @@ public void setTimeSettings(TimeSettings settings)
/** Set time left.
@param color Color to set the time for.
@param time New value for time left.
- @param movesLeft -1, if not in byoyomi.
- */
+ @param movesLeft -1, if not in byoyomi. */
public void setTimeLeft(GoColor color, long time, int movesLeft)
{
halt();
@@ -304,8 +294,7 @@ public void setTimeLeft(GoColor color, long time, int movesLeft)
/** Start time for a move.
If the clock was already running, the passed time for the current move
- is discarded.
- */
+ is discarded. */
public void startMove(GoColor color)
{
assert color.isBlackWhite();
@@ -318,8 +307,7 @@ public void startMove(GoColor color)
/** Stop time for a move.
If the clock was running, the time for the move is added to the
total time for the color the clock was running for; otherwise
- this function does nothing.
- */
+ this function does nothing. */
public void stopMove()
{
if (! m_isRunning)
@@ -5,8 +5,7 @@
import net.sf.gogui.go.GoColor;
/** Const functions of game.Clock.
- @see Clock
-*/
+ @see Clock */
public interface ConstClock
{
int getMovesLeft(GoColor color);
@@ -6,8 +6,7 @@
import net.sf.gogui.go.GoColor;
/** Const functions of game.Game.
- @see Game
-*/
+ @see Game */
public interface ConstGame
{
ConstBoard getBoard();
@@ -7,8 +7,7 @@
import net.sf.gogui.go.Score.ScoringMethod;
/** Const functions of game.GameInfo.
- @see GameInfo
-*/
+ @see GameInfo */
public interface ConstGameInfo
{
String get(StringInfo type);
@@ -3,8 +3,7 @@
package net.sf.gogui.game;
/** Const functions of game.GameTree.
- @see GameTree
-*/
+ @see GameTree */
public interface ConstGameTree
{
int getBoardSize();
@@ -9,8 +9,7 @@
import net.sf.gogui.go.Move;
/** Const functions of game.Node.
- @see Node
-*/
+ @see Node */
public interface ConstNode
{
String getComment();
@@ -5,8 +5,7 @@
import java.util.ArrayList;
/** Const functions of game.SgfProperties.
- @see SgfProperties
-*/
+ @see SgfProperties */
public interface ConstSgfProperties
{
int getNumberValues(String key);
@@ -46,17 +46,15 @@ public void addMarked(GoPoint point, MarkType type)
/** Clear modified flag.
Can be used for instance after game was saved.
- @see #isModified()
- */
+ @see #isModified() */
public void clearModified()
{
m_modified = false;
}
/** Append new empty node and make it current node.
Can be use for instance to prepare for setup stones if current node
- contains a move.
- */
+ contains a move. */
public void createNewChild()
{
Node node = new Node();
@@ -134,8 +132,7 @@ public void haltClock()
}
/** Return last node when startClock() was called.
- @return The last such node or null, if the clock was never running.
- */
+ @return The last such node or null, if the clock was never running. */
public ConstNode getClockNode()
{
return m_clockNode;
@@ -161,8 +158,7 @@ public final void init(GameTree tree)
/** Check if game was modified.
@return true, if game was mofified since constructor or last call to
- one of the init() functions or to clearModified().
- */
+ one of the init() functions or to clearModified(). */
public boolean isModified()
{
return m_modified;
@@ -241,8 +237,7 @@ public void resumeClock()
/** Set clock listener.
If the clock has a listener, the clock should be stopped with
haltClock() if it is no longer used, otherwise the timer thread can
- keep an application from terminating.
- */
+ keep an application from terminating. */
public void setClockListener(Clock.Listener listener)
{
m_clock.setListener(listener);
@@ -318,8 +313,7 @@ public void setToMove(GoColor color)
}
/** Change the time settings.
- If the current node is the root node, the clock will also be reset.
- */
+ If the current node is the root node, the clock will also be reset. */
public void setTimeSettings(TimeSettings timeSettings)
{
Node node = m_tree.getGameInfoNode(m_current);
@@ -353,8 +347,7 @@ public void setMovesLeft(ConstNode node, GoColor c, int moves)
/** Set a stone on the board or remove a stone.
@param p The location.
- @param c The color of the stone (EMPTY for removal).
- */
+ @param c The color of the stone (EMPTY for removal). */
public void setup(GoPoint p, GoColor c)
{
assert p != null;
@@ -383,8 +376,7 @@ public void startClock()
}
/** Truncate current node and subtree.
- New current node is the father of the old current node.
- */
+ New current node is the father of the old current node. */
public void truncate()
{
Node father = m_current.getFather();
Oops, something went wrong.

0 comments on commit 8a713fe

Please sign in to comment.