From: samhemelryk <samhemelryk>
Date: Mon, 19 Oct 2009 04:27:10 +0000 (+0000)
Subject: NOBUG: Testing the new CVS server by updating a few comments
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=0baa5d46006fc00a44dc8bd0f3e352b218d3f63e;p=moodle.git

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

diff --git a/lib/navigationlib.php b/lib/navigationlib.php
index b93ac3b68c..ddd9c7efa4 100644
--- a/lib/navigationlib.php
+++ b/lib/navigationlib.php
@@ -210,6 +210,12 @@ class navigation_node {
      * 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