From 935d7a707d050e867abe7e52e9b5c9e9a9e06f63 Mon Sep 17 00:00:00 2001
From: Stein Magnus Jodal <stein.magnus@jodal.no>
Date: Sat, 20 Mar 2010 02:39:54 +0100
Subject: [PATCH] docs: Add docs for mopidy.mpd.server

---
 docs/api/mpd.rst       | 18 +++++++++++++++---
 mopidy/mpd/frontend.py |  2 +-
 mopidy/mpd/server.py   | 14 +++++++++++++-
 3 files changed, 29 insertions(+), 5 deletions(-)

diff --git a/docs/api/mpd.rst b/docs/api/mpd.rst
index a74302dc..bd630cc2 100644
--- a/docs/api/mpd.rst
+++ b/docs/api/mpd.rst
@@ -1,8 +1,20 @@
-************************************************
-:mod:`mopidy.mpd` -- MPD protocol implementation
-************************************************
+*****************
+:mod:`mopidy.mpd`
+*****************
+
+MPD protocol implementation
+===========================
 
 .. automodule:: mopidy.mpd.frontend
     :synopsis: Our implementation of the MPD protocol.
     :members:
     :undoc-members:
+
+
+MPD server implementation
+=========================
+
+.. automodule:: mopidy.mpd.server
+    :synopsis: Our MPD server implementation.
+    :members:
+    :undoc-members:
diff --git a/mopidy/mpd/frontend.py b/mopidy/mpd/frontend.py
index cb8d109a..f9404eb4 100644
--- a/mopidy/mpd/frontend.py
+++ b/mopidy/mpd/frontend.py
@@ -1,5 +1,5 @@
 """
-Our MPD protocol implementation
+This is our MPD protocol implementation.
 
 This is partly based upon the `MPD protocol documentation
 <http://www.musicpd.org/doc/protocol/>`_, which is a useful resource, but it is
diff --git a/mopidy/mpd/server.py b/mopidy/mpd/server.py
index 575acb20..a08cf4c4 100644
--- a/mopidy/mpd/server.py
+++ b/mopidy/mpd/server.py
@@ -1,3 +1,7 @@
+"""
+This is our MPD server implementation.
+"""
+
 import asynchat
 import asyncore
 import logging
@@ -17,7 +21,11 @@ ENCODING = u'utf-8'
 LINE_TERMINATOR = u'\n'
 
 class MpdServer(asyncore.dispatcher):
-    def __init__(self, core_queue=None):
+    """
+    The MPD server. Creates a :class:`MpdSession` for each client connection.
+    """
+
+    def __init__(self, core_queue):
         asyncore.dispatcher.__init__(self)
         self.core_queue = core_queue
         self.create_socket(socket.AF_INET, socket.SOCK_STREAM)
@@ -47,6 +55,10 @@ class MpdServer(asyncore.dispatcher):
 
 
 class MpdSession(asynchat.async_chat):
+    """
+    The MPD client session. Dispatches MPD requests to the frontend.
+    """
+
     def __init__(self, server, client_socket, client_address, core_queue):
         asynchat.async_chat.__init__(self, sock=client_socket)
         self.server = server