summaryrefslogtreecommitdiffstats
path: root/service
diff options
context:
space:
mode:
authorBernhard Posselt <dev@bernhard-posselt.com>2014-06-26 11:33:44 +0200
committerBernhard Posselt <dev@bernhard-posselt.com>2014-06-26 11:33:44 +0200
commitcd10f93e0d271840caff92b88195385a2a3f15b2 (patch)
treecf9e3724c35bba4cdd82e443938151bf189802cc /service
parent06367d8b81407fc2948e0f666b38f4de2dffbd89 (diff)
style fixes
Diffstat (limited to 'service')
-rw-r--r--service/feedservice.php10
-rw-r--r--service/folderservice.php2
-rw-r--r--service/itemservice.php14
-rw-r--r--service/service.php2
4 files changed, 14 insertions, 14 deletions
diff --git a/service/feedservice.php b/service/feedservice.php
index cc4c8770d..6c8d90033 100644
--- a/service/feedservice.php
+++ b/service/feedservice.php
@@ -66,7 +66,7 @@ class FeedService extends Service {
/**
* Finds all feeds of a user
* @param string $userId the name of the user
- * @return array of feeds
+ * @return Feed[]
*/
public function findAll($userId){
return $this->feedMapper->findAllFromUser($userId);
@@ -103,7 +103,7 @@ class FeedService extends Service {
throw new ServiceConflictException(
$this->l10n->t('Can not add feed: Exists already'));
- // If no matchin feed was found everything was ok
+ // If no matching feed was found everything was ok
} catch(DoesNotExistException $ex){}
// insert feed
@@ -258,7 +258,7 @@ class FeedService extends Service {
/**
* Import articles
* @param array $json the array with json
- * @param string userId the username
+ * @param string $userId the username
* @return Feed if one had to be created for nonexistent feeds
*/
public function importArticles($json, $userId) {
@@ -275,7 +275,7 @@ class FeedService extends Service {
$createdFeed = false;
// loop over all items and get the corresponding feed
- // if the feed does not exist, create a seperate feed for them
+ // if the feed does not exist, create a separate feed for them
foreach ($json as $entry) {
$item = Item::fromImport($entry);
$item->setLastModified($this->timeFactory->getTime());
@@ -324,7 +324,7 @@ class FeedService extends Service {
/**
- * Use this to mark a feed as deleted. That way it can be undeleted
+ * Use this to mark a feed as deleted. That way it can be un-deleted
* @param int $feedId the id of the feed that should be deleted
* @param string $userId the name of the user for security reasons
* @throws ServiceNotFoundException when feed does not exist
diff --git a/service/folderservice.php b/service/folderservice.php
index 208eace9a..5622a5260 100644
--- a/service/folderservice.php
+++ b/service/folderservice.php
@@ -113,7 +113,7 @@ class FolderService extends Service {
/**
- * Use this to mark a folder as deleted. That way it can be undeleted
+ * Use this to mark a folder as deleted. That way it can be un-deleted
* @param int $folderId the id of the folder that should be deleted
* @param string $userId the name of the user for security reasons
* @throws ServiceNotFoundException when folder does not exist
diff --git a/service/itemservice.php b/service/itemservice.php
index b2ab80bc5..dcabb2f11 100644
--- a/service/itemservice.php
+++ b/service/itemservice.php
@@ -107,7 +107,7 @@ class ItemService extends Service {
* @param int $feedId the id of the item's feed that should be starred
* @param string $guidHash the guidHash of the item that should be starred
* @param boolean $isStarred if true the item will be marked as starred, if false unstar
- * @param $userId the name of the user for security reasons
+ * @param string $userId the name of the user for security reasons
* @throws ServiceNotFoundException if the item does not exist
*/
public function star($feedId, $guidHash, $isStarred, $userId){
@@ -131,7 +131,7 @@ class ItemService extends Service {
* Read or unread an item
* @param int $itemId the id of the item that should be read
* @param boolean $isRead if true the item will be marked as read, if false unread
- * @param $userId the name of the user for security reasons
+ * @param string $userId the name of the user for security reasons
* @throws ServiceNotFoundException if the item does not exist
*/
public function read($itemId, $isRead, $userId){
@@ -149,7 +149,7 @@ class ItemService extends Service {
/**
* Set all items read
* @param int $highestItemId all items below that are marked read. This is used
- * to prevent marking items as read that the users hasnt seen yet
+ * to prevent marking items as read that the users hasn't seen yet
* @param string $userId the name of the user
*/
public function readAll($highestItemId, $userId){
@@ -162,7 +162,7 @@ class ItemService extends Service {
* Set a folder read
* @param int $folderId the id of the folder that should be marked read
* @param int $highestItemId all items below that are marked read. This is used
- * to prevent marking items as read that the users hasnt seen yet
+ * to prevent marking items as read that the users hasn't seen yet
* @param string $userId the name of the user
*/
public function readFolder($folderId, $highestItemId, $userId){
@@ -175,7 +175,7 @@ class ItemService extends Service {
* Set a feed read
* @param int $feedId the id of the feed that should be marked read
* @param int $highestItemId all items below that are marked read. This is used
- * to prevent marking items as read that the users hasnt seen yet
+ * to prevent marking items as read that the users hasn't seen yet
* @param string $userId the name of the user
*/
public function readFeed($feedId, $highestItemId, $userId){
@@ -187,7 +187,7 @@ class ItemService extends Service {
/**
* This method deletes all unread feeds that are not starred and over the
* count of $this->autoPurgeCount starting by the oldest. This is to clean
- * up the database so that old entries dont spam your db. As criteria for
+ * up the database so that old entries don't spam your db. As criteria for
* old, the id is taken
*/
public function autoPurgeOld(){
@@ -196,7 +196,7 @@ class ItemService extends Service {
/**
- * Returns the newest itemd id, use this for marking feeds read
+ * Returns the newest item id, use this for marking feeds read
* @param string $userId the name of the user
* @throws ServiceNotFoundException if there is no newest item
* @return int
diff --git a/service/service.php b/service/service.php
index cecd33687..c4edbb9bc 100644
--- a/service/service.php
+++ b/service/service.php
@@ -47,7 +47,7 @@ abstract class Service {
* @param string $userId the name of the user for security reasons
* @throws ServiceNotFoundException if the entity does not exist, or there
* are more than one of it
- * @return Entity the entity
+ * @return \OCP\AppFramework\Db\Entity the entity
*/
public function find($id, $userId){
try {