summaryrefslogtreecommitdiff
path: root/inc/changelog.php
diff options
context:
space:
mode:
authorDominik Eckelmann <deckelmann@gmail.com>2010-11-13 19:04:26 +0100
committerMichael Hamann <michael@content-space.de>2010-11-13 19:41:53 +0100
commita365baeef4fc0b6d593043c6db53c01671de9490 (patch)
tree371c7a03668f386108db1412efa620697b691201 /inc/changelog.php
parente8bc5751ed12895c27ba23882497cbfce4df661e (diff)
downloadrpg-a365baeef4fc0b6d593043c6db53c01671de9490.tar.gz
rpg-a365baeef4fc0b6d593043c6db53c01671de9490.tar.bz2
improved some metadata comments
Diffstat (limited to 'inc/changelog.php')
-rw-r--r--inc/changelog.php9
1 files changed, 9 insertions, 0 deletions
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>