From 56b3e3dcd833a8a9124581b536c69806962b9640 Mon Sep 17 00:00:00 2001
From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Wed, 22 Sep 2010 16:56:55 +0000
Subject: Refs #2450: Documented a few more classes.

git-svn-id: http://code.elgg.org/elgg/trunk@6956 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/classes/ElggPlugin.php | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

(limited to 'engine/classes/ElggPlugin.php')

diff --git a/engine/classes/ElggPlugin.php b/engine/classes/ElggPlugin.php
index 921665f4d..c666b8438 100644
--- a/engine/classes/ElggPlugin.php
+++ b/engine/classes/ElggPlugin.php
@@ -1,8 +1,12 @@
 <?php
 /**
- * @class ElggPlugin Object representing a plugin's settings for a given site.
- * This class is currently a stub, allowing a plugin to saving settings in an object's metadata for each site.
- * @author Curverider Ltd
+ * Stores site-side plugin settings as private data.
+ *
+ * This class is currently a stub, allowing a plugin to
+ * save settings in an object's private settings for each site.
+ *
+ * @package Elgg.Core
+ * @subpackage Plugins.Settings
  */
 class ElggPlugin extends ElggObject {
 	protected function initialise_attributes() {
@@ -16,7 +20,10 @@ class ElggPlugin extends ElggObject {
 	}
 
 	/**
-	 * Override entity get and sets in order to save data to private data store.
+	 * Get a value from private settings.
+	 *
+	 * @param string $name
+	 * @return mixed
 	 */
 	public function get($name) {
 		// See if its in our base attribute
@@ -37,7 +44,10 @@ class ElggPlugin extends ElggObject {
 	}
 
 	/**
-	 * Override entity get and sets in order to save data to private data store.
+	 * Save a value to private settings.
+	 *
+	 * @param string $name
+	 * @param mixed $value
 	 */
 	public function set($name, $value) {
 		if (array_key_exists($name, $this->attributes)) {
-- 
cgit v1.2.3