improved documentation of elgg_register_extender_url_handler()

git-svn-id: http://code.elgg.org/elgg/trunk@9072 36083f99-b078-4883-b0ff-0f9b5a30f544

diff --git a/engine/lib/extender.php b/engine/lib/extender.php
index a017c9eec626b7e4cca6702da27477aa9c14c194..ab04ea6749e502a2c5c7d3288e1f4b1054a8b456 100644 (file)
--- a/engine/lib/extender.php
+++ b/engine/lib/extender.php
@@ -161,13 +161,13 @@ function can_edit_extender($extender_id, $type, $user_guid = 0) {
 /**
  * Sets the URL handler for a particular extender type and name.
  * It is recommended that you do not call this directly, instead use
- * one of the wrapper functions in the subtype files.
+ * one of the wrapper functions such as elgg_register_annotation_url_handler().
  *
  * @param string $function_name The function to register
- * @param string $extender_type Extender type
+ * @param string $extender_type Extender type ('annotation', 'metadata')
  * @param string $extender_name The name of the extender
  *
- * @return true|false Depending on success
+ * @return bool
  */
 function elgg_register_extender_url_handler($extender_type, $extender_name, $function_name) {