diff options
| author | Dominik Eckelmann <deckelmann@gmail.com> | 2010-11-13 19:04:26 +0100 |
|---|---|---|
| committer | Michael Hamann <michael@content-space.de> | 2010-11-13 19:41:53 +0100 |
| commit | a365baeef4fc0b6d593043c6db53c01671de9490 (patch) | |
| tree | 371c7a03668f386108db1412efa620697b691201 /inc/parserutils.php | |
| parent | e8bc5751ed12895c27ba23882497cbfce4df661e (diff) | |
| download | rpg-a365baeef4fc0b6d593043c6db53c01671de9490.tar.gz rpg-a365baeef4fc0b6d593043c6db53c01671de9490.tar.bz2 | |
improved some metadata comments
Diffstat (limited to 'inc/parserutils.php')
| -rw-r--r-- | inc/parserutils.php | 9 |
1 files changed, 9 insertions, 0 deletions
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){ |