From 7969e9bbf46552640e27ea589a77fcf3610ee2b6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= <ondra@ondrovo.com>
Date: Mon, 20 Aug 2018 22:59:03 +0200
Subject: [PATCH] added some doc comments

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

diff --git a/app/Http/Controllers/SitemapController.php b/app/Http/Controllers/SitemapController.php
index 0952d9d..726a99a 100644
--- a/app/Http/Controllers/SitemapController.php
+++ b/app/Http/Controllers/SitemapController.php
@@ -8,8 +8,14 @@ use App\Models\Table;
 use App\Models\User;
 use XMLWriter;
 
+/**
+ * This controller is responsible for producing a XML sitemap
+ */
 class SitemapController extends Controller
 {
+    /**
+     * Render a sitemap to the browser
+     */
     public function sitemap()
     {
         ob_end_clean();
@@ -57,6 +63,12 @@ class SitemapController extends Controller
         $xmlWriter->endDocument();
     }
 
+    /**
+     * Go through all tables and other links and return objects
+     * that can be turned into sitemap entries.
+     *
+     * @return \Generator|object[]
+     */
     private function iterateTables()
     {
         $prio_info = .9;
@@ -100,6 +112,7 @@ class SitemapController extends Controller
             'priority' => $prio_misc,
         ];
 
+        // User profiles
         foreach (User::all() as $user) {
             yield (object)[
                 'url' => route('profile.view', $user->name),
@@ -108,6 +121,7 @@ class SitemapController extends Controller
             ];
         }
 
+        // Tables
         foreach (Table::all() as $table) {
             yield (object)[
                 'url' => $table->viewRoute,