From fa28de48ca51b0c83d1380256bf6b50d4c353aa3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Michal=20Kv=C3=A1=C4=8Dek?= <michal@binarity.cz>
Date: Thu, 7 Apr 2016 23:17:48 +0200
Subject: [PATCH] DOCUMENTATION: add documentation for controller with sitemap

---
 app/Http/Controllers/Sitemap.php | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/app/Http/Controllers/Sitemap.php b/app/Http/Controllers/Sitemap.php
index dc29cd81..21a1b603 100644
--- a/app/Http/Controllers/Sitemap.php
+++ b/app/Http/Controllers/Sitemap.php
@@ -22,13 +22,22 @@ class Sitemap extends Controller
         $this->content = $content;
     }
 
+    /**
+     * Get sitemap for all content pages
+     * 
+     * @return mixed
+     */
     public function getMap()
     {
+        // load all public pages
         $pages = $this->content->getPageQuery()
                                ->get();
 
 
+        // iterate over all pages and add tag for each of them
         foreach ($pages as $page) {
+            
+            // is this page a homepage? because of URL
             if ($page->is_homepage) {
                 $route = route('page.index');
                 $priority = 1;
@@ -37,10 +46,12 @@ class Sitemap extends Controller
                 $priority = 0.8;
             }
 
+            // add to all pages
             \Sitemap::addTag($route, $page->updated_at, 'daily', $priority);
 
         }
 
+        // print sitemap
         return \Sitemap::render();
     }
 }