From af5bb6929020e32533a3a67f4fedc5e0ea483eb6 Mon Sep 17 00:00:00 2001
From: Daniel James <daniel@calamity.org.uk>
Date: Sun, 11 Dec 2016 14:56:42 +0000
Subject: [PATCH] Rename/comment a few variables and functions

---
 common/code/boost_documentation.php |  4 ++--
 development/pull_requests.php       | 10 +++++-----
 doc/display_extra_docs.php          |  2 +-
 doc/display_libs.php                |  2 +-
 doc/libraries.php                   | 16 ++++++++--------
 5 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/common/code/boost_documentation.php b/common/code/boost_documentation.php
index 2b5b99f9..7d2067f2 100644
--- a/common/code/boost_documentation.php
+++ b/common/code/boost_documentation.php
@@ -21,7 +21,7 @@ class BoostDocumentation
     var $path;
     var $use_http_expire_date;
 
-    static function library_documentation() {
+    static function library_documentation_page() {
         return static::documentation_page(array(
             'fix_dir' => BOOST_FIX_DIR,
             'archive_dir' => STATIC_DIR,
@@ -29,7 +29,7 @@ class BoostDocumentation
         ));
     }
 
-    static function extra_documentation() {
+    static function extra_documentation_page() {
         return static::documentation_page(array(
             'boost-root' => '../libs/release/',
         ));
diff --git a/development/pull_requests.php b/development/pull_requests.php
index 1c9ea7c7..14ff2ad7 100644
--- a/development/pull_requests.php
+++ b/development/pull_requests.php
@@ -12,20 +12,20 @@ class PullRequestPage {
         'date' => 'By Age',
     );
 
-    var $params;
+    var $params;            // Normalised URL parameters
 
     var $pull_requests;
     var $last_updated;
 
-    var $base_uri;
-    var $page_view;
+    var $page_url_path;     // URL path for this page
+    var $page_view;         // Grouped by library, or sorted by age.
 
     function __construct($params) {
         $json_data = json_decode(
                 file_get_contents(BOOST_DATA_DIR.'/pull-requests.json'));
         $this->pull_requests = $json_data->pull_requests;
         $this->last_updated = $json_data->last_updated;
-        $this->base_uri = preg_replace('![#?].*!', '', $_SERVER['REQUEST_URI']);
+        $this->page_url_path = preg_replace('![#?].*!', '', $_SERVER['REQUEST_URI']);
 
         $this->params = array();
         foreach (self::$param_defaults as $key => $default) {
@@ -135,7 +135,7 @@ class PullRequestPage {
                 }
             }
 
-            echo '<a href="' . html_encode($this->base_uri . $url_params) . '">',
+            echo '<a href="' . html_encode($this->page_url_path . $url_params) . '">',
             html_encode($description), '</a>';
         }
     }
diff --git a/doc/display_extra_docs.php b/doc/display_extra_docs.php
index 3205e319..2e97a5ba 100644
--- a/doc/display_extra_docs.php
+++ b/doc/display_extra_docs.php
@@ -10,7 +10,7 @@ if (strpos($_SERVER['REQUEST_URI'], '//') !== FALSE)
 
 require_once(dirname(__FILE__) . '/../common/code/bootstrap.php');
 
-BoostDocumentation::extra_documentation()->display_from_archive(
+BoostDocumentation::extra_documentation_page()->display_from_archive(
   array(
   array('', '@[.](html|htm)$@i','basic','text/html')
   )
diff --git a/doc/display_libs.php b/doc/display_libs.php
index 3dcbb93c..f890cd61 100644
--- a/doc/display_libs.php
+++ b/doc/display_libs.php
@@ -54,7 +54,7 @@ EOS;
     return str_ireplace('</head>', $analytics.'</head>', $content);
 }
 
-BoostDocumentation::library_documentation()->display_from_archive(
+BoostDocumentation::library_documentation_page()->display_from_archive(
   array(
   //~ special cases that can't be processed at all (some redirects)
   array('','@^libs/gil/doc/.*(html|htm)$@i','raw','text/html'),
diff --git a/doc/libraries.php b/doc/libraries.php
index 6d9084d3..dffdab17 100644
--- a/doc/libraries.php
+++ b/doc/libraries.php
@@ -38,12 +38,12 @@ class LibraryPage {
         'boost-version' => 'First Release'
     );
 
-    var $params;
+    var $params;            // Normalised URL parameters
     var $libs;
     var $documentation_page;
     var $categories;
 
-    var $base_uri;
+    var $page_url_path;     // URL path for this page
     var $view_value;
     var $sort_value;
     var $attribute_filter;
@@ -54,17 +54,17 @@ class LibraryPage {
         $this->libs = $libs;
         $this->categories = $libs->get_categories();
 
-        $this->documentation_page = BoostDocumentation::library_documentation();
+        $this->documentation_page = BoostDocumentation::library_documentation_page();
 
         // To avoid confusion, only show this page when there is actual documentation.
         if (!is_dir($this->documentation_page->documentation_dir())) {
             BoostWeb::throw_error_404($_SERVER['REQUEST_URI']);
         }
 
-        $base_uri = $_SERVER['REQUEST_URI'];
-        $base_uri = preg_replace('@[#?].*@', '', $base_uri);
-        $base_uri = preg_replace('@//+@', '/', $base_uri);
-        $this->base_uri = $base_uri;
+        $page_url_path = $_SERVER['REQUEST_URI'];
+        $page_url_path = preg_replace('@[#?].*@', '', $page_url_path);
+        $page_url_path = preg_replace('@//+@', '/', $page_url_path);
+        $this->page_url_path = $page_url_path;
 
         $this->params = array();
         foreach (self::$param_defaults as $key => $default) {
@@ -280,7 +280,7 @@ class LibraryPage {
                 }
             }
 
-            echo '<a href="' . html_encode($this->base_uri . $url_params) . '">',
+            echo '<a href="' . html_encode($this->page_url_path . $url_params) . '">',
             html_encode($description), '</a>';
         }
     }