From a365baeef4fc0b6d593043c6db53c01671de9490 Mon Sep 17 00:00:00 2001
From: Dominik Eckelmann <deckelmann@gmail.com>
Date: Sat, 13 Nov 2010 19:04:26 +0100
Subject: [PATCH] improved some metadata comments
---
inc/changelog.php | 9 +++++++++
inc/parserutils.php | 9 +++++++++
2 files changed, 18 insertions(+)
diff --git a/inc/changelog.php b/inc/changelog.php
index bb00df76c..cc7612bfd 100644
--- a/inc/changelog.php
+++ b/inc/changelog.php
@@ -37,6 +37,15 @@ function parseChangelogLine($line) {
/**
* Add's an entry to the changelog and saves the metadata for the page
*
+ * @param int $date Timestamp of the change
+ * @param String $id Name of the affected page
+ * @param String $type Type of the change see DOKU_CHANGE_TYPE_*
+ * @param String $summary Summary of the change
+ * @param mixed $extra In case of a revert the revision (timestmp) of the reverted page
+ * @param array $flags Additional flags in a key value array.
+ * Availible flags:
+ * - ExternalEdit - mark as an external edit.
+ *
* @author Andreas Gohr <andi@splitbrain.org>
* @author Esther Brunner <wikidesign@gmail.com>
* @author Ben Coburn <btcoburn@silicodon.net>
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 <esther@kaffeehaus.ch>
*/
function p_set_metadata($id, $data, $render=false, $persistent=true){
--
GitLab