From 5f80c291b7dc9690e66d6b8dec1b94af8f51255b Mon Sep 17 00:00:00 2001
From: Chris Boden <cboden@gmail.com>
Date: Fri, 11 May 2012 00:51:11 -0400
Subject: [PATCH] CS and API docs

---
 src/Ratchet/AbstractConnectionDecorator.php               | 4 ++++
 src/Ratchet/ConnectionInterface.php                       | 4 ++++
 src/Ratchet/Server/IoConnection.php                       | 3 +--
 src/Ratchet/Wamp/{JSONException.php => JsonException.php} | 2 +-
 src/Ratchet/Wamp/WampConnection.php                       | 2 ++
 src/Ratchet/Wamp/WampServer.php                           | 4 ++--
 src/Ratchet/WebSocket/WsConnection.php                    | 1 +
 7 files changed, 15 insertions(+), 5 deletions(-)
 rename src/Ratchet/Wamp/{JSONException.php => JsonException.php} (95%)

diff --git a/src/Ratchet/AbstractConnectionDecorator.php b/src/Ratchet/AbstractConnectionDecorator.php
index c683fa3..c85fa32 100644
--- a/src/Ratchet/AbstractConnectionDecorator.php
+++ b/src/Ratchet/AbstractConnectionDecorator.php
@@ -1,6 +1,10 @@
 <?php
 namespace Ratchet;
 
+/**
+ * Wraps ConnectionInterface objects via the decorator pattern but allows 
+ * parameters to bubble through with magic methods
+ */
 abstract class AbstractConnectionDecorator implements ConnectionInterface {
     /**
      * @var ConnectionInterface
diff --git a/src/Ratchet/ConnectionInterface.php b/src/Ratchet/ConnectionInterface.php
index 0bb63d1..8d8098c 100644
--- a/src/Ratchet/ConnectionInterface.php
+++ b/src/Ratchet/ConnectionInterface.php
@@ -3,6 +3,10 @@ namespace Ratchet;
 
 const VERSION = 'Ratchet/0.1';
 
+/**
+ * A proxy object representing a connection to the application
+ * This acts as a container to storm data (in memory) about the connection
+ */
 interface ConnectionInterface {
     /**
      * Send data to the connection
diff --git a/src/Ratchet/Server/IoConnection.php b/src/Ratchet/Server/IoConnection.php
index 5338435..e7492b8 100644
--- a/src/Ratchet/Server/IoConnection.php
+++ b/src/Ratchet/Server/IoConnection.php
@@ -4,8 +4,7 @@ use Ratchet\ConnectionInterface;
 use React\Socket\ConnectionInterface as ReactConn;
 
 /**
- * A proxy object representing a connection to the application
- * This acts as a container to storm data (in memory) about the connection
+ * {@inheritdoc}
  */
 class IoConnection implements ConnectionInterface {
     /**
diff --git a/src/Ratchet/Wamp/JSONException.php b/src/Ratchet/Wamp/JsonException.php
similarity index 95%
rename from src/Ratchet/Wamp/JSONException.php
rename to src/Ratchet/Wamp/JsonException.php
index c9ee20f..dfb8da9 100644
--- a/src/Ratchet/Wamp/JSONException.php
+++ b/src/Ratchet/Wamp/JsonException.php
@@ -1,7 +1,7 @@
 <?php
 namespace Ratchet\Wamp;
 
-class JSONException extends Exception {
+class JsonException extends Exception {
     public function __construct() {
         $code = json_last_error();
 
diff --git a/src/Ratchet/Wamp/WampConnection.php b/src/Ratchet/Wamp/WampConnection.php
index c98ad65..1522953 100644
--- a/src/Ratchet/Wamp/WampConnection.php
+++ b/src/Ratchet/Wamp/WampConnection.php
@@ -5,6 +5,8 @@ use Ratchet\AbstractConnectionDecorator;
 use Ratchet\Wamp\WampServer as WAMP;
 
 /**
+ * A ConnectionInterface object wrapper that is passed to your WAMP application
+ * representing a client. Methods on this Connection are therefore different. 
  * @property stdClass $WAMP
  */
 class WampConnection extends AbstractConnectionDecorator {
diff --git a/src/Ratchet/Wamp/WampServer.php b/src/Ratchet/Wamp/WampServer.php
index 82ebda6..ae2e03b 100644
--- a/src/Ratchet/Wamp/WampServer.php
+++ b/src/Ratchet/Wamp/WampServer.php
@@ -72,13 +72,13 @@ class WampServer implements WsServerInterface {
     /**
      * @{inheritdoc}
      * @throws Exception
-     * @throws JSONException
+     * @throws JsonException
      */
     public function onMessage(ConnectionInterface $from, $msg) {
         $from = $this->connections[$from];
 
         if (null === ($json = @json_decode($msg, true))) {
-            throw new JSONException;
+            throw new JsonException;
         }
 
         switch ($json[0]) {
diff --git a/src/Ratchet/WebSocket/WsConnection.php b/src/Ratchet/WebSocket/WsConnection.php
index ce769bc..c0f127b 100644
--- a/src/Ratchet/WebSocket/WsConnection.php
+++ b/src/Ratchet/WebSocket/WsConnection.php
@@ -3,6 +3,7 @@ namespace Ratchet\WebSocket;
 use Ratchet\AbstractConnectionDecorator;
 
 /**
+ * {@inheritdoc}
  * @property stdClass $WebSocket
  */
 class WsConnection extends AbstractConnectionDecorator {