From a365baeef4fc0b6d593043c6db53c01671de9490 Mon Sep 17 00:00:00 2001 From: Dominik Eckelmann Date: Sat, 13 Nov 2010 19:04:26 +0100 Subject: improved some metadata comments --- inc/parserutils.php | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'inc/parserutils.php') diff --git a/inc/parserutils.php b/inc/parserutils.php index b8b063fc3..a50e3f4f3 100644 --- a/inc/parserutils.php +++ b/inc/parserutils.php @@ -252,6 +252,15 @@ function p_get_metadata($id, $key='', $render=false){ /** * sets metadata elements of a page * + * @see http://www.dokuwiki.org/devel:metadata#functions_to_get_and_set_metadata + * + * @param String $id is the ID of a wiki page + * @param Array $data is an array with key ⇒ value pairs to be set in the metadata + * @param Boolean $render whether or not the page metadata should be generated with the renderer + * @param Boolean $persistent indicates whether or not the particular metadata value will persist through + * the next metadata rendering. + * @return boolean true on success + * * @author Esther Brunner */ function p_set_metadata($id, $data, $render=false, $persistent=true){ -- cgit v1.2.3