From 13e0151cd2569832588cc9a973bcf40d850edd53 Mon Sep 17 00:00:00 2001
From: Klaus Weidenbach <Klaus.Weidenbach@gmx.net>
Date: Fri, 18 Jan 2019 22:17:10 +0100
Subject: Correct and extend Doxygen comments.

Correct some documentation errors for Doxygen and add
more comments.
Document some undefined variables with @FIXME.
---
 Zotlabs/Lib/PConfig.php | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'Zotlabs/Lib/PConfig.php')

diff --git a/Zotlabs/Lib/PConfig.php b/Zotlabs/Lib/PConfig.php
index 69f4de2db..95f07d580 100644
--- a/Zotlabs/Lib/PConfig.php
+++ b/Zotlabs/Lib/PConfig.php
@@ -112,9 +112,11 @@ class PConfig {
 	 *  The configuration key to set
 	 * @param string $value
 	 *  The value to store
+	 * @param string $updated (optional)
+	 *  The datetime to store
 	 * @return mixed Stored $value or false
 	 */
-	static public function Set($uid, $family, $key, $value, $updated=NULL) {
+	static public function Set($uid, $family, $key, $value, $updated = NULL) {
 
 		// this catches subtle errors where this function has been called
 		// with local_channel() when not logged in (which returns false)
@@ -239,7 +241,9 @@ class PConfig {
 	 *  The category of the configuration value
 	 * @param string $key
 	 *  The configuration key to delete
-	 * @return mixed
+	 * @param string $updated (optional)
+	 *  The datetime to store
+	 * @return boolean
 	 */
 	static public function Delete($uid, $family, $key, $updated = NULL) {
 
@@ -283,6 +287,7 @@ class PConfig {
 		if(! array_key_exists($family, \App::$config[$uid]['transient']))
 			\App::$config[$uid]['transient'][$family] = array();
 
+		/// @FIXME $new is undefined, so dead code
 		if ($new) {
 			\App::$config[$uid]['transient'][$family]['pcfgdel:'.$key] = $updated;
 		}
-- 
cgit v1.2.3