From fa3393674c854e884abf10d3b82dab03aca83c61 Mon Sep 17 00:00:00 2001
From: Robin Appelman <icewind@owncloud.com>
Date: Thu, 4 Sep 2014 01:10:02 +0200
Subject: Better phpdoc and method naming

---
 lib/private/appframework/core/api.php | 2 +-
 lib/private/server.php                | 4 ++--
 lib/public/ieventsource.php           | 2 ++
 lib/public/iservercontainer.php       | 4 ++--
 4 files changed, 7 insertions(+), 5 deletions(-)

(limited to 'lib')

diff --git a/lib/private/appframework/core/api.php b/lib/private/appframework/core/api.php
index 0dd3a583868..279f4bf97f7 100644
--- a/lib/private/appframework/core/api.php
+++ b/lib/private/appframework/core/api.php
@@ -114,7 +114,7 @@ class API implements IApi{
 	 * @return \OCP\IEventSource a new open EventSource class
 	 */
 	public function openEventSource(){
-		return \OC::$server->getEventSource();
+		return \OC::$server->createEventSource();
 	}
 
 	/**
diff --git a/lib/private/server.php b/lib/private/server.php
index 1c3b1b03ce9..0c663e8553a 100644
--- a/lib/private/server.php
+++ b/lib/private/server.php
@@ -494,11 +494,11 @@ class Server extends SimpleContainer implements IServerContainer {
 	}
 
 	/**
-	 * Returns a search instance
+	 * Create a new event source
 	 *
 	 * @return \OCP\IEventSource
 	 */
-	function getEventSource() {
+	function createEventSource() {
 		return new \OC_EventSource();
 	}
 }
diff --git a/lib/public/ieventsource.php b/lib/public/ieventsource.php
index ea4bfc73d42..eb7853c5e90 100644
--- a/lib/public/ieventsource.php
+++ b/lib/public/ieventsource.php
@@ -13,6 +13,8 @@ namespace OCP;
  * includes a fallback for older browsers and IE
  *
  * use server side events with caution, to many open requests can hang the server
+ *
+ * The event source will initialize the connection to the client when the first data is sent
  */
 interface IEventSource {
 	/**
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php
index 24d8894d9fe..1abf0d9938d 100644
--- a/lib/public/iservercontainer.php
+++ b/lib/public/iservercontainer.php
@@ -237,9 +237,9 @@ interface IServerContainer {
 	function getCertificateManager($user = null);
 	
 	/**
-	 * Returns a search instance
+	 * Create a new event source
 	 *
 	 * @return \OCP\IEventSource
 	 */
-	function getEventSource();
+	function createEventSource();
 }
-- 
cgit v1.2.3