Mercurial > SimpleWebPresenter

diff Sitemap.inc @ 74:1d5166aba2c5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documentation fixes. codeFromHeader now throws an exception if the header is malformed.
author Tom Fredrik Blenning Klaussen <bfg@blenning.no>
date Fri, 12 Oct 2012 01:16:30 +0200
parents 947d53f95ccd
children 7c68015b211a
line wrap: on
line diff
--- a/Sitemap.inc	Fri Oct 12 01:06:32 2012 +0200
+++ b/Sitemap.inc	Fri Oct 12 01:16:30 2012 +0200
@@ -8,11 +8,19 @@
 $cache->includeOnce('Options.inc', dirname(__FILE__));
 /// @endcond
 
+/**
+ * Functionality for generating a sitemap
+ */
 class Sitemap
 {
   private $master;
   private $options;
 
+  /**
+   * Constructs a sitemap object from a master document
+   *
+   * @param $path location of master document
+   */
   function __construct($path) {
     $this->master = new DOMDocument();
     $this->master->load($path);