From f116d5a9152ae226a9b7317b6817e5df8e204e9b Mon Sep 17 00:00:00 2001
From: Bernhard Posselt <dev@bernhard-posselt.com>
Date: Tue, 13 May 2014 00:35:24 +0200
Subject: docs for enhancers

---
 articleenhancer/articleenhancer.php      | 4 ++++
 articleenhancer/enhancer.php             | 1 +
 articleenhancer/regexarticleenhancer.php | 4 ++++
 articleenhancer/xpatharticleenhancer.php | 5 ++++-
 4 files changed, 13 insertions(+), 1 deletion(-)

(limited to 'articleenhancer')

diff --git a/articleenhancer/articleenhancer.php b/articleenhancer/articleenhancer.php
index e5bf2f7aa..0587f4bad 100644
--- a/articleenhancer/articleenhancer.php
+++ b/articleenhancer/articleenhancer.php
@@ -17,5 +17,9 @@ use \OCA\News\Db\Item;
 
 
 interface ArticleEnhancer {
+    /**
+     * @param \OCA\News\Db\Item $item
+     * @return \OCA\News\Db\Item enhanced item
+     */
 	public function enhance(Item $item);
 }
\ No newline at end of file
diff --git a/articleenhancer/enhancer.php b/articleenhancer/enhancer.php
index 9d4a644ab..cfdc960b6 100644
--- a/articleenhancer/enhancer.php
+++ b/articleenhancer/enhancer.php
@@ -37,6 +37,7 @@ class Enhancer {
 	/**
 	 * @param \OCA\News\Db\Item $item
 	 * @param string $feedUrl
+	 * @return \OCA\News\Db\Item enhanced item
 	 */
 	public function enhance($item, $feedUrl){
 		$feedUrl = $this->removeTrailingSlash($feedUrl);
diff --git a/articleenhancer/regexarticleenhancer.php b/articleenhancer/regexarticleenhancer.php
index 9fecc0d6f..443562769 100644
--- a/articleenhancer/regexarticleenhancer.php
+++ b/articleenhancer/regexarticleenhancer.php
@@ -28,6 +28,10 @@ class RegexArticleEnhancer implements ArticleEnhancer {
 	}
 
 
+	/**
+	 * @param \OCA\News\Db\Item $item
+	 * @return \OCA\News\Db\Item enhanced item
+	 */
 	public function enhance(Item $item) {
 		if (preg_match($this->matchArticleUrl, $item->getUrl())) {
 			$body = $item->getBody();
diff --git a/articleenhancer/xpatharticleenhancer.php b/articleenhancer/xpatharticleenhancer.php
index b0614065f..6761fd0c5 100644
--- a/articleenhancer/xpatharticleenhancer.php
+++ b/articleenhancer/xpatharticleenhancer.php
@@ -43,7 +43,10 @@ class XPathArticleEnhancer implements ArticleEnhancer {
 		$this->config = $config;
 	}
 
-
+	/**
+	 * @param \OCA\News\Db\Item $item
+	 * @return \OCA\News\Db\Item enhanced item
+	 */
 	public function enhance(Item $item){
 
 		foreach($this->regexXPathPair as $regex => $search) {
-- 
cgit v1.2.3