From ac63eb124bfd255d7d85a420e5247228417f4148 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jonatan=20P=C3=A5lsson?= <jonte@jonte-ThinkPad-T410.(none)>
Date: Wed, 16 Feb 2011 15:48:55 +0100
Subject: [PATCH] Added specification and documentation for the dispatcher

---
 src/ggs_dispatcher.erl | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/src/ggs_dispatcher.erl b/src/ggs_dispatcher.erl
index e69de29..8f89ceb 100644
--- a/src/ggs_dispatcher.erl
+++ b/src/ggs_dispatcher.erl
@@ -0,0 +1,21 @@
+-module(ggs_dispatcher).
+-export([start_link/1, stop/1]).
+
+%% @doc This module is the entry-point for clients connecting to GGS. This is
+%% the module responsible for:
+%%  * Greeting a connecting client, and associating a socket for it
+%%  * Spawning a ggs_player for the connecting client, passing the socket
+
+%% @doc Starts a new dispatcher with the specified port. Registers this 
+%% dispatcher under the name "ggs_dispatcher". The pid of the dispatcher
+%% is returned.
+%% @spec start_link(Port) -> Pid
+%%      Port = Integer
+%%      Pid = #<Pid>
+start_link(Port) ->
+    not_implemented.
+
+%% @doc Stops the dispatcher with the specified reason.
+%% @spec stop(Reason) -> ok.
+%%      Reason = String
+stop(Reason) -> not_implemented.