add doc comments, tag as pre-release

controllers/CommentController.php

@@ -7,7 +7,7 @@
 use yii\web\BadRequestHttpException;
 
 /**
- * CommentController implements an interface and actions for CRUD for the coomenttable.
+ * CommentController implements an interface and actions for CRUD for the cooment table.
   *
  * @author petersmithca
  */
@@ -47,7 +47,6 @@ public function actions()
 
     /**
      * Overrides Index functionality to sort comments and limit result set
-     * @param integer $id
      * @return mixed
      */
     public function actionIndex(){

controllers/NotificationController.php

@@ -5,10 +5,18 @@
 use humhub\modules\api\controllers\BaseController;
 use humhub\modules\notification\models\Notification;
 
+/**
+ * NotificationController implements an interface and actions for listing notifications.
+  *
+ * @author petersmithca
+ */
 class NotificationController extends BaseController
 {
     public $modelClass = 'humhub\modules\notification\models\Notification';
 
+    /**
+     * @inheritdoc
+     */
     public function actions()
     {
         $actions = parent::actions();
@@ -18,7 +26,6 @@ public function actions()
 
     /**
      * Overrides Index functionality to return only unseeen notifications
-     * @param integer $id
      * @return mixed
      */
     public function actionIndex(){

controllers/PostController.php

@@ -9,6 +9,7 @@
 class PostController extends BaseController
 {
     public $modelClass = 'humhub\modules\api\models\Post';
+
     /**
      * @inheritdoc
      */

controllers/ProfileController.php

@@ -7,6 +7,9 @@ class ProfileController extends BaseController
 {
     public $modelClass = 'humhub\modules\api\models\Profile';
 
+    /**
+     * @inheritdoc
+     */
     public function actions()
     {
         $actions = parent::actions();

controllers/SpaceController.php

@@ -8,6 +8,9 @@ class SpaceController extends BaseController
 {
     public $modelClass = 'humhub\modules\space\models\Space';
 
+    /**
+     * @inheritdoc
+     */
     public function actions()
     {
         $actions = parent::actions();

controllers/UserController.php

@@ -10,13 +10,21 @@ class UserController extends BaseController
 {
     public $modelClass = 'humhub\modules\api\models\User';
 
+    /**
+     * @inheritdoc
+     */
     public function actions()
     {
         $actions = parent::actions();
         unset($actions['index'], $actions['view'], $actions['delete'], $actions['update'], $actions['create']);
         return $actions;
     }
 
+    /**
+     * Allows searching users by user name, returning a list of matches.
+     * @param string $search
+     * @return mixed
+     */
     public function actionSearch($search)
     {
         $request = Yii::$app->request;
@@ -32,6 +40,13 @@ public function actionSearch($search)
         return $query->all();
     }
 
+    /**
+     * Login end point, which will return a user matching the passes uername and password
+     * including walls 
+     * @param string $username
+     * @param string $password
+     * @return mixed
+     */
     public function actionLogin($username, $password) {
         $auth = new AccountLogin();
         $auth->username = $username;
@@ -47,6 +62,12 @@ public function actionLogin($username, $password) {
         }
     }
 
+    /**
+     * Overrides Index functionality to return a list of users
+     * will include the user's profile if the optional `eager` paramter is true
+     * @param boolean $eager
+     * @return mixed
+     */
     public function actionIndex($eager = false){
 
         $users = User::find()

models/Content.php

@@ -6,12 +6,15 @@
 use humhub\modules\api\models\Post;
 
 /**
- * User model extends humhub User model to implement relationships.
+ * Content model extends humhub Content model to implement relationships.
   *
  * @author petersmithca
  */
 class Content extends \humhub\modules\content\models\Content
 {
+    /**
+     * Identifies relationship between Content and Post
+     */
     public function getPosts()
     {
         return $this->hasMany(Post::className(), ['id' => 'object_id']);

models/Profile.php

@@ -6,12 +6,16 @@
 use humhub\modules\api\models\User;
 
 /**
- * User model extends humhub User model to implement relationships.
+ * Profile model extends humhub Profile model to implement relationships.
   *
  * @author petersmithca
  */
 class Profile extends \humhub\modules\user\models\Profile
 {
+
+	/**
+     * Identifies relationship between Profile and User
+     */
     public function getUser()
     {
         return $this->hasOne(User::className(), ['id' => 'user_id']);

models/User.php

@@ -13,11 +13,18 @@
  */
 class User extends \humhub\modules\user\models\User
 {
+
+	/**
+     * Identifies relationship between User and Post
+     */
     public function getPosts()
     {
         return $this->hasMany(Post::className(), ['created_by' => 'id']);
     }
 
+    /**
+     * Identifies relationship between User and Profile
+     */
     public function getProfile()
     {
         return $this->hasOne(Profile::className(), ['user_id' => 'id']);

module.json

@@ -3,7 +3,7 @@
     "name": "API",
     "description": "Adds REST EPI Endpoints.",
     "keywords": ["api", "rest"],
-    "version": "0.1.0",
+    "version": "0.9.0",
     "humhub": {
         "minVersion": "0.20"
     }