added some documentation

This commit is contained in:
Roland Lehmann 2011-06-11 16:38:31 +02:00
parent c841987427
commit a9019b9099

View File

@ -68,11 +68,15 @@ class GoogleSitemap extends Controller {
* Note that all registered DataObjects need the method AbsoluteLink(). * Note that all registered DataObjects need the method AbsoluteLink().
* *
* @param string $className name of DataObject to register * @param string $className name of DataObject to register
* @param string $changeFreq * @param string $changeFreq how often is this DataObject updated?
* Possible values:
* always, hourly, daily, weekly, monthly, yearly, never
* @param string $priority How important is this DataObject in comparison to other urls?
* Possible values: 0.1, 0.2 ... , 0.9, 1.0
* *
* @return void * @return void
*/ */
public static function register_dataobject($className, $changeFreq = 'monthly', $priority = 0.6) { public static function register_dataobject($className, $changeFreq = 'monthly', $priority = '0.6') {
if (!self::is_registered($className)) { if (!self::is_registered($className)) {
Object::add_extension($className, 'GoogleSitemapDecorator'); Object::add_extension($className, 'GoogleSitemapDecorator');
self::$google_sitemap_dataobjects[] = $className; self::$google_sitemap_dataobjects[] = $className;