From 7a61f5813ccc6d0d78e23c1f79daf327160e3b65 Mon Sep 17 00:00:00 2001
From: Oleksii Kriuchykhin <okriuchykhin@biosistemika.com>
Date: Tue, 9 May 2017 10:18:57 +0200
Subject: [PATCH] Add comments to the code [SCI-152]

---
 app/controllers/my_module_comments_controller.rb | 5 +++--
 app/controllers/project_comments_controller.rb   | 1 +
 app/controllers/user_my_modules_controller.rb    | 2 +-
 app/controllers/user_projects_controller.rb      | 2 +-
 4 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/app/controllers/my_module_comments_controller.rb b/app/controllers/my_module_comments_controller.rb
index 1b1d239da..d489dad71 100644
--- a/app/controllers/my_module_comments_controller.rb
+++ b/app/controllers/my_module_comments_controller.rb
@@ -77,8 +77,8 @@ class MyModuleCommentsController < ApplicationController
               }
             ),
             date: @comment.created_at.strftime('%d.%m.%Y'),
-            linked_id: @my_module.id,
-            counter: @my_module.task_comments.count
+            linked_id: @my_module.id, # Used for counter badge
+            counter: @my_module.task_comments.count # Used for counter badge
           },
           status: :created
         end
@@ -155,6 +155,7 @@ class MyModuleCommentsController < ApplicationController
               module: @my_module.name
             )
           )
+          # 'counter' and 'linked_id' are used for counter badge
           render json: { linked_id: @my_module.id,
                          counter: @my_module.task_comments.count },
                  status: :ok
diff --git a/app/controllers/project_comments_controller.rb b/app/controllers/project_comments_controller.rb
index da7354627..c4007c94e 100644
--- a/app/controllers/project_comments_controller.rb
+++ b/app/controllers/project_comments_controller.rb
@@ -146,6 +146,7 @@ class ProjectCommentsController < ApplicationController
               project: @project.name
             )
           )
+          # 'counter' and 'linked_id' are used for counter badge
           render json: { linked_id: @project.id,
                          counter: @project.project_comments.count },
                  status: :ok
diff --git a/app/controllers/user_my_modules_controller.rb b/app/controllers/user_my_modules_controller.rb
index c13c9240b..29701f721 100644
--- a/app/controllers/user_my_modules_controller.rb
+++ b/app/controllers/user_my_modules_controller.rb
@@ -15,7 +15,7 @@ class UserMyModulesController < ApplicationController
             partial: 'index.html.erb'
           ),
           my_module_id: @my_module.id,
-          counter: @my_module.users.count
+          counter: @my_module.users.count # Used for counter badge
         }
       end
     end
diff --git a/app/controllers/user_projects_controller.rb b/app/controllers/user_projects_controller.rb
index 5beb34ee7..cf3dd65f0 100644
--- a/app/controllers/user_projects_controller.rb
+++ b/app/controllers/user_projects_controller.rb
@@ -19,7 +19,7 @@ class UserProjectsController < ApplicationController
             partial: 'index.html.erb'
           ),
           project_id: @project.id,
-          counter: @project.users.count
+          counter: @project.users.count # Used for counter badge
         }
       end
     end