NOBUG: Testing the new CVS server by updating a few comments

ralferlebach · Oct 19, 2009 · 0baa5d4 · 0baa5d4
1 parent 9fa7821
commit 0baa5d4
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/navigationlib.php b/lib/navigationlib.php
@@ -210,6 +210,12 @@ public static function override_active_url(moodle_url $url=null) {
      * This function checks if the node is the active child by comparing its action
      * to the current page URL obtained via $ME
      *
+     * This function compares the nodes url to the static var {@link navigation_node::fullmeurl}
+     * and if they match (based on $strenght) then the node is considered active.
+     *
+     * Note: This function is recursive, when you call it it will check itself and all
+     * children recursivily.
+     *
      * @staticvar moodle_url $fullmeurl
      * @param int $strength When using the moodle_url compare function how strictly
      *                       to check for a match. Defaults to URL_MATCH_EXACT