summaryrefslogtreecommitdiff
path: root/inc/indexer.php
diff options
context:
space:
mode:
authorMichael Hamann <michael@content-space.de>2013-01-26 11:17:59 +0100
committerMichael Hamann <michael@content-space.de>2013-01-26 11:17:59 +0100
commitaf73bba62fb11d7872a8b108b156d451302695bd (patch)
treeb8d4578027e1b0e273d513df0ca9e5689087294c /inc/indexer.php
parentb1cfdc5fd569b4dc4b06d4443191b1e2bff27567 (diff)
downloadrpg-af73bba62fb11d7872a8b108b156d451302695bd.tar.gz
rpg-af73bba62fb11d7872a8b108b156d451302695bd.tar.bz2
Clarified the behavior of the Doku_Indexer::renamePage method
Diffstat (limited to 'inc/indexer.php')
-rw-r--r--inc/indexer.php4
1 files changed, 3 insertions, 1 deletions
diff --git a/inc/indexer.php b/inc/indexer.php
index 70eac035b..37ca92055 100644
--- a/inc/indexer.php
+++ b/inc/indexer.php
@@ -339,7 +339,9 @@ class Doku_Indexer {
}
/**
- * Rename a page in the search index without changing the indexed content
+ * Rename a page in the search index without changing the indexed content. This function doesn't check if the
+ * old or new name exists in the filesystem. It returns an error if the old page isn't in the page list of the
+ * indexer and it deletes all previously indexed content of the new page.
*
* @param string $oldpage The old page name
* @param string $newpage The new page name