2fbcca0516fd

Render initarg/initforms into docs
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Thu, 24 Mar 2016 14:03:32 +0000
parents 0f3f3fce2751
children 157ba01ed645
branches/tags (none)
files docs/03-reference.markdown

Changes

--- a/docs/03-reference.markdown	Wed Mar 23 23:04:20 2016 +0000
+++ b/docs/03-reference.markdown	Thu Mar 24 14:03:32 2016 +0000
@@ -20,58 +20,67 @@
 
 #### Slot NAME
 
-* Allocation: INSTANCE
+* Allocation: `:INSTANCE`
 * Type: `STRING`
+* Initarg: `:NAME`
+* Initform: `"CL-GGP"`
 * Reader: `PLAYER-NAME`
 
 The name of the player.
 
 #### Slot PORT
 
-* Allocation: INSTANCE
+* Allocation: `:INSTANCE`
 * Type: `(INTEGER 0)`
+* Initarg: `:PORT`
+* Initform: `9999`
 * Reader: `PLAYER-PORT`
 
 The port the HTTP server should listen on.
 
 #### Slot MATCH-ROLES
 
-* Allocation: INSTANCE
+* Allocation: `:INSTANCE`
 * Type: `(OR NULL LIST)`
+* Initform: `NIL`
 * Reader: `PLAYER-MATCH-ROLES`
 
 A list of the roles for the current match.  Feel free to read and use this if you like.  **Do not modify this.**
 
 #### Slot START-CLOCK
 
-* Allocation: INSTANCE
+* Allocation: `:INSTANCE`
 * Type: `(OR NULL (INTEGER 1))`
+* Initform: `NIL`
 
 The start clock for the current game.  **Do not touch this.**  Use the `timeout` value passed to your methods instead.
 
 #### Slot PLAY-CLOCK
 
-* Allocation: INSTANCE
+* Allocation: `:INSTANCE`
 * Type: `(OR NULL (INTEGER 1))`
+* Initform: `NIL`
 
 The play clock for the current game.  **Do not touch this.**  Use the `timeout` value passed to your methods instead.
 
 #### Slot MESSAGE-START
 
-* Allocation: INSTANCE
+* Allocation: `:INSTANCE`
 * Type: `(OR NULL (INTEGER 0))`
+* Initform: `NIL`
 
 The (internal-real) timestamp of when the current GGP message was received.  **Do not touch this.**  Use the `timeout` value passed to your methods instead.
 
 #### Slot CURRENT-MATCH
 
-* Allocation: INSTANCE
+* Allocation: `:INSTANCE`
+* Initform: `NIL`
 
 The ID of the current match the player is playing, or `nil` if it is waiting.  **Do not touch this.**
 
 #### Slot SERVER
 
-* Allocation: INSTANCE
+* Allocation: `:INSTANCE`
 
 The Clack server object of the player.  **Do not touch this.**  Use `start-player` and `kill-player` to start/stop the server safely.