From de3986efcb52948d7774d908845095d5afb6ed59 Mon Sep 17 00:00:00 2001
From: manfromhuh <manfromhuh@memeware.net>
Date: Tue, 5 Jul 2022 14:45:16 -0400
Subject: [PATCH] Add comments to page_menu.php

---
 common/page_menu.php | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/common/page_menu.php b/common/page_menu.php
index ce207b5..bd5f5c1 100644
--- a/common/page_menu.php
+++ b/common/page_menu.php
@@ -4,6 +4,7 @@
 <?php
 include_once ($_SERVER['DOCUMENT_ROOT'].'/common/get_month_name.php');
 
+//Removes the number used to keep articles in post order from the displayed title.
 function remove_sorting_number($link_title){
   $first_three = mb_substr($link_title, 0, 3,"UTF-8");
   
@@ -31,14 +32,14 @@ if (file_exists($dir) && is_dir($dir) ) {
         $file_array[] = $file;
       }
     }
-    foreach($file_array as $file) {
-      $_replace = array('.php', '.html', '.htm');
-      $link_title = str_replace('_',' ',$file);
+    foreach($file_array as $file) {//Renders the folder names as more readable titles.
+      $_replace = array('.php', '.html', '.htm');//Remove file extensions from webpages.
+      $link_title = str_replace('_',' ',$file);//Remove undersores and replace them with spaces
       $link_title = str_replace($_replace,'',$link_title);
-      $link_title = ucwords($link_title);
-      $link_title = get_month_name($link_title);
-      $link_title = remove_sorting_number($link_title);
-      echo("<ul><li><a href='$file'> $link_title </a></li></ul>\n");
+      $link_title = ucwords($link_title);//Set the first letter of each word to upercase.
+      $link_title = get_month_name($link_title);//
+      $link_title = remove_sorting_number($link_title);//Removes the number used to keep articles in post order from the displayed title.
+      echo("<ul><li><a href='$file'> $link_title </a></li></ul>\n");//Output the result.
     }
 }
 else {