diff options
| author | Mario Lang <mlang@delysid.org> | 2004-01-05 18:53:34 +0000 |
|---|---|---|
| committer | Mario Lang <mlang@delysid.org> | 2004-01-05 18:53:34 +0000 |
| commit | 0795b988979ca518d55d0d60cd1202c10add141e (patch) | |
| tree | e3b2107c6794d507c1f1536bea8f486f17162296 /chess-display.el | |
| parent | 46ec5aae9140e0120f7f024f0a58c0d94bc9399c (diff) | |
checkdoc attempt, some ver ysimple (I hope correct) docstrings added
Diffstat (limited to 'chess-display.el')
| -rw-r--r-- | chess-display.el | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/chess-display.el b/chess-display.el index 9ae6fbb..b570c6c 100644 --- a/chess-display.el +++ b/chess-display.el @@ -108,6 +108,7 @@ See `mode-line-format' for syntax details." new-display)) (defsubst chess-display-perspective (display) + "Return the current perspective of DISPLAY." (chess-with-current-buffer display chess-display-perspective)) @@ -118,11 +119,13 @@ See `mode-line-format' for syntax details." (erase-buffer))) ; force a complete redraw (defun chess-display-set-perspective (display perspective) + "Set PERSPECTIVE of DISPLAY." (chess-with-current-buffer display (chess-display-set-perspective* nil perspective) (chess-display-update nil))) (defun chess-display-set-position (display &optional position my-color) + "Set the game associated with DISPLAY to use POSITION and MY-COLOR." (chess-with-current-buffer display (if position (progn @@ -134,7 +137,7 @@ See `mode-line-format' for syntax details." (chess-display-set-index nil 0))) (defun chess-display-position (display) - "Return the position currently viewed." + "Return the position currently viewed on DISPLAY." (chess-with-current-buffer display (if chess-display-edit-mode chess-display-edit-position @@ -153,10 +156,10 @@ See `mode-line-format' for syntax details." (chess-game-ply chess-module-game chess-display-index))) (defun chess-display-set-variation (display variation &optional index) - "Set the display variation. -This will cause the first ply in the variation to be displayed, with -the user able to scroll back and forth through the moves in the -variation. Any moves made on the board will extend/change the + "Set DISPLAY VARIATION. +If INDEX is not specified, this will cause the first ply in the variation +to be displayed, with the user able to scroll back and forth through the +moves in the variation. Any moves made on the board will extend/change the variation that was passed in." (chess-with-current-buffer display (let ((chess-game-inhibit-events t)) |