Many PHPDocs, some unused and dyn declared vars

many PHPDocs
some unused variables
some dynamically declared variables declared

1 files changed, 12 insertions, 6 deletions

diff --git a/inc/Sitemapper.php b/inc/Sitemapper.php
index 33f6d7a36..0325f6d44 100644
--- a/inc/Sitemapper.php
+++ b/inc/Sitemapper.php
@@ -24,6 +24,8 @@ class Sitemapper {
      * @author Andreas Gohr
      * @link   https://www.google.com/webmasters/sitemaps/docs/en/about.html
      * @link   http://www.sitemaps.org/
+     *
+     * @return bool
      */
     public static function generate(){
         global $conf;
@@ -75,6 +77,7 @@ class Sitemapper {
      *
      * @param $items array The SitemapItems that shall be included in the sitemap.
      * @return string The sitemap XML.
+     *
      * @author Michael Hamann
      */
     private static function getXML($items) {
@@ -95,6 +98,7 @@ class Sitemapper {
      * Helper function for getting the path to the sitemap file.
      *
      * @return string The path to the sitemap file.
+     *
      * @author Michael Hamann
      */
     public static function getFilePath() {
@@ -123,6 +127,8 @@ class Sitemapper {
      * urls to ping using the SITEMAP_PING event.
      *
      * @author Michael Hamann
+     *
+     * @return bool
      */
     public static function pingSearchEngines() {
         //ping search engines...
@@ -168,9 +174,9 @@ class SitemapItem {
     /**
      * Create a new item.
      *
-     * @param $url string The url of the item
-     * @param $lastmod int Timestamp of the last modification
-     * @param $changefreq string How frequently the item is likely to change. Valid values: always, hourly, daily, weekly, monthly, yearly, never.
+     * @param string $url        The url of the item
+     * @param int    $lastmod    Timestamp of the last modification
+     * @param string $changefreq How frequently the item is likely to change. Valid values: always, hourly, daily, weekly, monthly, yearly, never.
      * @param $priority float|string The priority of the item relative to other URLs on your site. Valid values range from 0.0 to 1.0.
      */
     public function __construct($url, $lastmod, $changefreq = null, $priority = null) {
@@ -183,9 +189,9 @@ class SitemapItem {
     /**
      * Helper function for creating an item for a wikipage id.
      *
-     * @param $id string A wikipage id.
-     * @param $changefreq string How frequently the item is likely to change. Valid values: always, hourly, daily, weekly, monthly, yearly, never.
-     * @param $priority float|string The priority of the item relative to other URLs on your site. Valid values     range from 0.0 to 1.0.
+     * @param string       $id         A wikipage id.
+     * @param string       $changefreq How frequently the item is likely to change. Valid values: always, hourly, daily, weekly, monthly, yearly, never.
+     * @param float|string $priority   The priority of the item relative to other URLs on your site. Valid values     range from 0.0 to 1.0.
      * @return SitemapItem The sitemap item.
      */
     public static function createFromID($id, $changefreq = null, $priority = null) {